Julia Jiang
62 řádky
1.7 KiB
Python
62 řádky
1.7 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
import re
|
|
import sys
|
|
import subprocess
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
version_numbers = []
|
|
version_file = open("../VERSION", "r")
|
|
lines = version_file.readlines()
|
|
for line in lines:
|
|
if line[0] == '#':
|
|
continue
|
|
version_numbers.append(line.strip())
|
|
version_number = ".".join(version_numbers)
|
|
left_nav_title = f"HIP {version_number} Documentation"
|
|
|
|
# for PDF output on Read the Docs
|
|
project = "HIP Documentation"
|
|
author = "Advanced Micro Devices, Inc."
|
|
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
|
|
version = version_number
|
|
release = version_number
|
|
|
|
external_toc_path = "./sphinx/_toc.yml"
|
|
|
|
docs_core = ROCmDocs(left_nav_title)
|
|
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
|
|
docs_core.enable_api_reference()
|
|
docs_core.setup()
|
|
|
|
external_projects_current_project = "hip"
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
|
|
|
# Add the _extensions directory to Python's search path
|
|
sys.path.append(str(Path(__file__).parent / 'extension'))
|
|
|
|
extensions += ["sphinxcontrib.doxylink", "custom_directive"]
|
|
|
|
cpp_id_attributes = ["__global__", "__device__", "__host__", "__forceinline__", "static"]
|
|
cpp_paren_attributes = ["__declspec"]
|
|
|
|
suppress_warnings = ["etoc.toctree"]
|
|
|
|
numfig = False
|
|
|
|
exclude_patterns = [
|
|
"./doxygen/mainpage.md",
|
|
"./understand/glossary.md",
|
|
'./how-to/debugging_env.rst',
|
|
"./reference/env_variables"
|
|
]
|