Apply doc standards for ReadtheDocs builds

Applies the following changes:
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

Change-Id: I947cf32cd42d9f4e55b1ddd324ad4a7e4ba3f3e3


[ROCm/ROCR-Runtime commit: 1c6ad56dc6]
This commit is contained in:
Sam Wu
2024-01-16 09:40:08 -07:00
committed by Sam Wu
parent 8450291bac
commit b9a5201cbc
9 changed files with 3101 additions and 0 deletions
@@ -0,0 +1,36 @@
# 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 os
import re
from rocm_docs import ROCmDocs
os.system("cp ../README.md index.md")
os.system("cp ../src/README.md structure.md")
with open('../src/CMakeLists.txt', encoding='utf-8') as f:
match = re.search(r'get_version \(\s+\"?([0-9.]+)[^0-9.]+', f.read())
if not match:
raise ValueError("VERSION not found!")
version_number = match[1]
left_nav_title = f"ROCR {version_number} Documentation"
# for PDF output on Read the Docs
project = "ROCR 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.setup()
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)