Sam Wu
67dc4b0f2a
Apply the following changes to project documentation for ReadtheDocs: add version number to documentation left navigation bar and page title add an "About" section with a license page enable htmlzip, pdf, epub formats when publishing on Read the Docs set pdf title, author, copyright, and version rename .sphinx/.doxygen to sphinx/doxygen remove docBin from URL update rocm-docs-core dependency update dependabot config Change-Id: Ife8c89a2e9323f436b3e54ef2a9e013c19b3b228
36 baris
1.2 KiB
Python
Executable File
36 baris
1.2 KiB
Python
Executable File
# 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
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
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"
|
|
|
|
# for PDF output on Read the Docs
|
|
project = "ROCm SMI LIB 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(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"
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|