systems-assistant[bot]
857e5ef3ce
Co-authored-by: Eisuke Kawashima <e-kwsm@users.noreply.github.com> Co-authored-by: systems-assistant[bot] <systems-assistant[bot]@users.noreply.github.com> Co-authored-by: Maisam Arif <Maisam.Arif@amd.com>
61 строка
1.9 KiB
Python
61 строка
1.9 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 pathlib
|
|
import shutil
|
|
import sys
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
# We need to add the location of the rocrand Python module to the PATH
|
|
# in order to build the documentation of that module
|
|
docs_dir_path = pathlib.Path(__file__).parent
|
|
python_dir_path = docs_dir_path.parent / 'python_smi_tools'
|
|
sys.path.append(str(python_dir_path))
|
|
|
|
with open('../CMakeLists.txt', encoding='utf-8') as f:
|
|
match = re.search(r'get_package_version_number\(\"?([0-9.]+)[^0-9.]+', f.read())
|
|
if not match:
|
|
raise ValueError("VERSION not found!")
|
|
version_number = match[1]
|
|
left_nav_title = f"ROCm SMI LIB {version_number} Documentation"
|
|
|
|
shutil.copy2('../CHANGELOG.md','./CHANGELOG.md')
|
|
|
|
# for PDF output on Read the Docs
|
|
project = "ROCm SMI LIB Documentation"
|
|
author = "Advanced Micro Devices, Inc."
|
|
copyright = "Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved."
|
|
version = version_number
|
|
release = version_number
|
|
|
|
external_toc_path = "./sphinx/_toc.yml"
|
|
|
|
exclude_patterns = ['CHANGELOG.md']
|
|
|
|
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 = "rocm_smi_lib"
|
|
|
|
suppress_warnings = ["etoc.toctree"]
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
|
|
|
extensions += ['sphinx.ext.mathjax']
|
|
|
|
# Necessary to remove the header comments from the rocm_smi module
|
|
def remove_module_docstring(app, what, name, obj, options, lines):
|
|
if what == "module":
|
|
del lines[:]
|
|
|
|
def setup(app):
|
|
app.connect("autodoc-process-docstring", remove_module_docstring)
|