Documentation standardization

Relates to ROCm/rocm-docs-core#330
samjwu · Oct 25, 2023 · 11612c3 · 11612c3
1 parent b8d453d
commit 11612c3
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 13 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/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,7 +10,7 @@ formats: [htmlzip, pdf, epub]
 
 python:
    install:
-   - requirements: docs/.sphinx/requirements.txt
+   - requirements: docs/sphinx/requirements.txt
 
 build:
    os: ubuntu-22.04

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Please follow the instructions below to build the documentation.
 ```
 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
 ```

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+_doxygen/
+doxygen/html/
+doxygen/xml/
diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,11 +4,31 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import re
+
 from rocm_docs import ROCmDocs
 
-docs_core = ROCmDocs("rocSOLVER Documentation")
-docs_core.run_doxygen()
+with open('../CMakeLists.txt', encoding='utf-8') as f:
+    match = re.search(r'set\(VERSION_STRING \"?([0-9.]+)[^0-9.]+', f.read())
+    if not match:
+        raise ValueError("VERSION not found!")
+    version_number = match[1]
+left_nav_title = f"rocSOLVER {version_number} Documentation"
+
+# for PDF output on Read the Docs
+project = "rocSOLVER 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.setup()
 
+external_projects_current_project = "rocsolver"
+
 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
@@ -57,7 +57,7 @@ PROJECT_BRIEF          = "implementation of LAPACK routines on the ROCm platform
 # 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
@@ -1575,7 +1575,7 @@ MATHJAX_CODEFILE       =
 # The default value is: YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-SEARCHENGINE           = YES
+SEARCHENGINE           = NO
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 # implemented using a web server instead of a web client using Javascript. There
@@ -2123,7 +2123,7 @@ TAGFILES               =
 # tag file that is based on the input files it reads. See section "Linking to
 # external documentation" for more information about the usage of tag files.
 
-GENERATE_TAGFILE       = 
+GENERATE_TAGFILE       = html/tagfile.xml
 
 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
 # the class index. If set to NO, only the inherited external classes will be
@@ -2354,7 +2354,7 @@ DIRECTORY_GRAPH        = YES
 # The default value is: png.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_IMAGE_FORMAT       = png
+DOT_IMAGE_FORMAT       = svg
 
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 # enable generation of interactive SVG images that allow zooming and panning.
@@ -2366,7 +2366,7 @@ DOT_IMAGE_FORMAT       = png
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-INTERACTIVE_SVG        = NO
+INTERACTIVE_SVG        = YES
 
 # The DOT_PATH tag can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found in the path.

diff --git a/docs/license.md b/docs/license.md
@@ -0,0 +1,4 @@
+# License
+
+```{include} ../LICENSE.md
+```
diff --git a/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in
@@ -30,3 +30,6 @@ subtrees:
         - file: api/refact
         - file: api/logging
         - file: api/deprecated
+  - caption: About
+    entries:
+      - file: license
diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in
@@ -0,0 +1 @@
+rocm-docs-core==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
@@ -92,7 +92,7 @@ requests==2.31.0
     # via
     #   pygithub
     #   sphinx
-rocm-docs-core==0.24.2
+rocm-docs-core==0.26.0
     # via -r requirements.in
 smmap==5.0.0
     # via gitdb