Documentation - Standardization (#1220)

* Add version number to documentation left navigation bar * Add an 'About' section with a license page * Rename .sphinx directory to sphinx * Update rocm-docs-core dependency * Update labels in dependabot config * Update build.os and requirements in rtd yaml config * Add caption to toc
ROCm · Oct 23, 2023 · 587eb32 · 587eb32
1 parent fc86891
commit 587eb32
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 10 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,14 +6,14 @@
 version: 2
 updates:
   - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/docs/.sphinx" # Location of package manifests
+    directory: "/docs/sphinx" # Location of package manifests
     open-pull-requests-limit: 10
     schedule:
       interval: "daily"
     target-branch: "develop"
     labels:
       - "docs"
       - "dependencies"
-      - "noCI"
+      - "ci:docs-only"
     reviewers:
       - "samjwu"
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,10 +10,10 @@ formats: [htmlzip]
 
 python:
    install:
-   - requirements: docs/.sphinx/requirements.txt
+   - requirements: docs/sphinx/requirements.txt
 
 build:
-   os: ubuntu-20.04
+   os: ubuntu-22.04
    tools:
       python: "3.8"
    apt_packages:

diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ Run the steps below to build documentation locally.
 * sphinx documentation
 ```Bash
 cd docs
-pip3 install -r .sphinx/requirements.txt
+pip3 install -r sphinx/requirements.txt
 python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```
 * Doxygen 

diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,8 +27,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import os
-from rocm_docs import ROCmDocs
+import re
 
+from rocm_docs import ROCmDocs
 
 external_projects_current_project = "mivisionx"
 
@@ -42,7 +43,23 @@
     print(f"cp {file_path[:-1]} {file_path[1:]}")
     os.system(f"cp {file_path[:-1]} {file_path[1:]}")
 
-docs_core = ROCmDocs("MIVisionX Documentation")
+with open("../CMakeLists.txt", encoding="utf-8") as f:
+    match = re.search(r"set\(VERSION\s+\"?([0-9.]+)[^0-9.]+", f.read())
+    if not match:
+        raise ValueError("VERSION not found!")
+    version_number = match[1]
+left_nav_title = f"MIVisionX {version_number} Documentation"
+
+# for PDF output on Read the Docs
+project = "MIVisionX 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()

diff --git a/docs/license.md b/docs/license.md
@@ -0,0 +1,4 @@
+# License
+
+```{include} ../LICENSE.txt
+```
diff --git a/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in
@@ -120,3 +120,6 @@ subtrees:
           - file: docker/pytorch/README
           - file: docker/tensorflow/README
     - file: CHANGELOG
+  - caption: About
+    entries:
+      - file: license
diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in
@@ -0,0 +1,2 @@
+rocm-docs-core[api_reference]==0.26.0
+
diff --git a/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt b/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt
@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    pip-compile requirements.in