Standardize documentation for ReadtheDocs (#360)

* Standardize documentation for ReadtheDocs * Use custom venv for RTD doxygen 1.9.8
ROCm · Jan 12, 2024 · 7328a6e · 7328a6e
1 parent 9e81cdf
commit 7328a6e
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 27 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,13 @@
 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"
+    labels:
+      - "documentation"
+      - "dependencies"
+      - "ci:docs-only"
+    reviewers:
+      - "samjwu"
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,6 @@
 ### Build dirs ###
 build/
 
-### Docs dirs ###
-doc/html/
-doc/xml/
-doc/latex/
-doc/*.tag
-
 # Created by https://www.gitignore.io/api/c++,cmake
 
 ### C++ ###

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -6,13 +6,16 @@ version: 2
 sphinx:
    configuration: docs/conf.py
 
-formats: [htmlzip]
+formats: [htmlzip, pdf, epub]
 
 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"
+      python: "mambaforge-22.9"
+
+conda:
+   environment: docs/environment.yml
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ You can build our documentation locally using the following commands:
 cd rocThrust; cd docs
 
 # Install Python dependencies
-python3 -m pip install -r .sphinx/requirements.txt
+python3 -m pip install -r sphinx/requirements.txt
 
 # Build the documentation
 python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,7 +1,5 @@
 /_build
 /_doxygen
-/_images
-/_static
-/_templates
-/.doxygen/docBin
-/.sphinx/_toc.yml
+/doxygen/html/
+/doxygen/xml/
+/sphinx/_toc.yml
diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,13 +4,30 @@
 # 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'rocm_setup_version\(VERSION\s+\"?([0-9.]+)[^0-9.]+', f.read())
+    if not match:
+        raise ValueError("VERSION not found!")
+    version_number = match[1]
+left_nav_title = f"rocThrust {version_number} Documentation"
 
-external_projects_current_project = "rocthrust"
+# for PDF output on Read the Docs
+project = "rocThrust 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("rocThrust Documentation")
-docs_core.run_doxygen(doxygen_root=".doxygen", doxygen_path=".doxygen/docBin/xml")
+docs_core = ROCmDocs(left_nav_title)
+docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
 docs_core.setup()
 
+external_projects_current_project = "rocthrust"
+
 for sphinx_var in ROCmDocs.SPHINX_VARS:
     globals()[sphinx_var] = getattr(docs_core, sphinx_var)
diff --git a/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile b/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docBin
+OUTPUT_DIRECTORY       = .
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -828,7 +828,8 @@ INPUT                  = ../../thrust \
                          ../../thrust/iterator \
                          ../../thrust/mr \
                          ../../thrust/random \
-                         ../../thrust/system
+                         ../../thrust/system \
+                         ../../README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -979,7 +980,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = ../README.md
+USE_MDFILE_AS_MAINPAGE = ../../README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -0,0 +1,10 @@
+name: RTD
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.8
+  - pip
+  - doxygen=1.9.8
+  - pip:
+    - -r ./sphinx/requirements.txt
diff --git a/docs/license.rst b/docs/license.rst
@@ -0,0 +1,4 @@
+License
+=======
+
+.. include:: ../LICENSE
diff --git a/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in
@@ -10,3 +10,6 @@ subtrees:
 - caption: API
   entries:
   - file: cpp_api
+- caption: About
+  entries:
+  - file: license
diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in
@@ -0,0 +1 @@
+rocm-docs-core==0.30.3
diff --git a/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt b/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt
@@ -84,9 +84,7 @@ pygments==2.15.0
     #   pydata-sphinx-theme
     #   sphinx
 pyjwt[crypto]==2.6.0
-    # via
-    #   pygithub
-    #   pyjwt
+    # via pygithub
 pynacl==1.5.0
     # via pygithub
 pytz==2023.3.post1