Files
rocm-systems/docs/conf.py
T
Sam Wu 29a532bd79 SWDEV-428554 - Standardize HIP Documentation
Relates to https://github.com/RadeonOpenCompute/rocm-docs-core/issues/330

Change-Id: I87468935a1aefa60158b8c07e3911845b3e8da36
2023-11-07 12:37:07 -05:00

40 řádky
1.2 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
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)