Standardize documentation for ReadtheDocs (#1027)
Este commit está contenido en:
+12
-5
@@ -8,9 +8,6 @@ import subprocess
|
||||
|
||||
from rocm_docs import ROCmDocs
|
||||
|
||||
|
||||
external_projects_current_project = "rccl"
|
||||
|
||||
name = "RCCL"
|
||||
get_major = r'sed -n -e "s/^NCCL_MAJOR.*\([0-9]\+\).*/\1/p" ../makefiles/version.mk'
|
||||
get_minor = r'sed -n -e "s/^NCCL_MINOR.*\([0-9]\{2,\}\).*/\1/p" ../makefiles/version.mk'
|
||||
@@ -18,12 +15,22 @@ get_patch = r'sed -n -e "s/^NCCL_PATCH.*\([0-9]\+\).*/\1/p" ../makefiles/version
|
||||
major = subprocess.getoutput(get_major)
|
||||
minor = subprocess.getoutput(get_minor)
|
||||
patch = subprocess.getoutput(get_patch)
|
||||
version_number = f"{major}.{minor}.{patch}"
|
||||
|
||||
# for PDF output on Read the Docs
|
||||
project = f"{name} Documentation"
|
||||
author = "Advanced Micro Devices, Inc."
|
||||
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
|
||||
version = version_number
|
||||
release = version_number
|
||||
|
||||
external_toc_path = "./sphinx/_toc.yml"
|
||||
|
||||
docs_core = ROCmDocs(f"{name} {major}.{minor}.{patch} Documentation")
|
||||
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/docBin/xml")
|
||||
docs_core = ROCmDocs(f"{name} {version_number} Documentation")
|
||||
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
|
||||
docs_core.setup()
|
||||
|
||||
external_projects_current_project = "rccl"
|
||||
|
||||
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
||||
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
||||
|
||||
Referencia en una nueva incidencia
Block a user