HIP Programming model

docs/.sphinx/_toc.yml.in

@@ -1,26 +1,39 @@
 root: index
 subtrees:
-- caption: User Guide
+- caption: User Reference
+  entries:
+    - file: .doxygen/docBin/html/index
+    - file: reference/programming_model
+    - file: reference/kernel_language
+    - file: reference/math_api
+    - file: reference/glossary
+    - file: reference/deprecated_api_list
+- caption: User Understand
+  entries:
+    - file: understand/programming_model
+- caption: User How to Guides
+  entries:
+    - file: how_to_guides/install.md
+- caption: User Tutorials
+  entries:
+    - file: tutorials/saxpy.md
+- caption: Developer How to Guides
+  entries:
+    - file: developer_guide/build
+- caption: Legacy Reference
+  entries:
+    - file: reference/terms
+- caption: Legacy User Guide
   entries:
     - file: user_guide/programming_manual
     - file: user_guide/hip_rtc
     - file: user_guide/faq
+- caption: Legacy How to Guides
+  entries:
+    - file: how_to_guides/debugging.md
     - file: user_guide/hip_porting_guide
     - file: user_guide/hip_porting_driver_api
-- caption: How to Guides
-  entries:
-  - file: how_to_guides/install.md
-  - file: how_to_guides/debugging.md
-- caption: Reference
-  entries:
-  - file: .doxygen/docBin/html/index
-  - file: reference/kernel_language
-  - file: reference/math_api
-  - file: reference/terms
-  - file: reference/glossary
-  - file: reference/deprecated_api_list
-- caption: Developer Guide
-  entries:
-  - file: developer_guide/build
-  - file: developer_guide/logging
-  - file: developer_guide/contributing.md
+- caption: Legacy Developer Guide
+  entries:
+    - file: developer_guide/logging
+    - file: developer_guide/contributing.md

docs/.sphinx/requirements.in

@@ -1 +1,2 @@
-rocm-docs-core[api_reference]==0.11.0
+rocm-docs-core[api_reference]==0.31.0
+sphinxcontrib.doxylink

docs/.sphinx/requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile requirements.in
+#    pip-compile docs/.sphinx/requirements.in
 #
 accessible-pygments==0.0.3
     # via pydata-sphinx-theme
@@ -41,7 +41,7 @@ docutils==0.16
     #   myst-parser
     #   pydata-sphinx-theme
     #   sphinx
-doxysphinx==3.2.1
+doxysphinx==3.3.4
     # via rocm-docs-core
 fastjsonschema==2.16.2
     # via rocm-docs-core
@@ -53,18 +53,16 @@ idna==3.3
     # via requests
 imagesize==1.4.1
     # via sphinx
-importlib-metadata==5.1.0
+importlib-metadata==7.0.1
     # via sphinx
-importlib-resources==5.10.4
+importlib-resources==6.1.1
     # via rocm-docs-core
 jinja2==3.1.2
     # via
     #   myst-parser
     #   sphinx
-json5==0.9.11
+libsass==0.22.0
     # via doxysphinx
-linkify-it-py==1.0.3
-    # via myst-parser
 lxml==4.9.2
     # via doxysphinx
 markdown-it-py==2.1.0
@@ -77,7 +75,9 @@ mdit-py-plugins==0.3.5
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
-myst-parser[linkify]==1.0.0
+mpire==2.7.1
+    # via doxysphinx
+myst-parser==1.0.0
     # via rocm-docs-core
 packaging==21.3
     # via
@@ -94,8 +94,11 @@ pygithub==1.58.2
 pygments==2.12.0
     # via
     #   accessible-pygments
+    #   mpire
     #   pydata-sphinx-theme
     #   sphinx
+pyjson5==1.6.3
+    # via doxysphinx
 pyjwt[crypto]==2.6.0
     # via pygithub
 pynacl==1.5.0
@@ -104,6 +107,9 @@ pyparsing==3.0.9
     # via
     #   doxysphinx
     #   packaging
+    #   sphinxcontrib-doxylink
+python-dateutil==2.8.2
+    # via sphinxcontrib-doxylink
 pytz==2022.1
     # via babel
 pyyaml==6.0
@@ -115,8 +121,10 @@ requests==2.28.1
     # via
     #   pygithub
     #   sphinx
-rocm-docs-core[api_reference]==0.11.0
-    # via -r requirements.in
+rocm-docs-core[api_reference]==0.31.0
+    # via -r docs/.sphinx/requirements.in
+six==1.16.0
+    # via python-dateutil
 smmap==5.0.0
     # via gitdb
 snowballstemmer==2.2.0
@@ -134,6 +142,7 @@ sphinx==5.3.0
     #   sphinx-design
     #   sphinx-external-toc
     #   sphinx-notfound-page
+    #   sphinxcontrib-doxylink
 sphinx-book-theme==1.0.1
     # via rocm-docs-core
 sphinx-copybutton==0.5.1
@@ -148,6 +157,8 @@ sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
     # via sphinx
+sphinxcontrib-doxylink==1.12.3
+    # via -r docs/.sphinx/requirements.in
 sphinxcontrib-htmlhelp==2.0.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
@@ -156,15 +167,15 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
+tqdm==4.65.0
+    # via mpire
 typing-extensions==4.4.0
     # via pydata-sphinx-theme
-uc-micro-py==1.0.1
-    # via linkify-it-py
 urllib3==1.26.11
     # via requests
 wrapt==1.15.0
     # via deprecated
-zipp==3.11.0
+zipp==3.17.0
     # via
     #   importlib-metadata
     #   importlib-resources

docs/conf.py

@@ -15,6 +15,9 @@
 for sphinx_var in ROCmDocs.SPHINX_VARS:
     globals()[sphinx_var] = getattr(docs_core, sphinx_var)
 
+extensions += ["sphinxcontrib.doxylink"]
+doxygen_html = ".doxygen/docBin/html"
+
 # rocm-docs-core might or might not have changed these yet (depending on version),
 # and we don't want to wipe their settings if they did
 if not "html_theme_options" in globals():