Merge pull request #842 from samjwu/proj

Add new doc projects and update rocm-docs-core docs
ROCm · Jul 4, 2024 · 5fd1521 · 5fd1521
2 parents 1148f4f + e95a89e
commit 5fd1521
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 11 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,32 +4,34 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-setting_all_article_info = True
-
 # Disable fetching projects.yaml, it would be the same as the local one anyway
 # except if a PR modifies it. We want to test with its version in that case
 external_projects_remote_repository = ""
 external_projects = ["hipify", "python", "rocm-docs-core", "rocm"]
-
 external_projects_current_project = "rocm-docs-core"
 
+setting_all_article_info = True
+
+all_article_info_os = ["linux", "windows"]
+
 # specific settings override any general settings (eg: all_article_info_<field>)
 article_pages = [
     {
         "file": "index",
         "os": ["linux", "windows"],
         "author": "Author: AMD",
-        "date": "2023-11-03",
+        "date": "2024-07-03",
         "read-time": "2 min read",
     },
     {"file": "developer_guide/commitizen"},
 ]
 
 html_theme = "rocm_docs_theme"
-html_theme_options = {"flavor": "rocm-blogs"}
+html_theme_options = {"flavor": "rocm"}
 
-extensions = ["rocm_docs", "rocm_docs.doxygen"]
 external_toc_path = "./sphinx/_toc.yml"
+
+extensions = ["rocm_docs", "rocm_docs.doxygen"]
 doxygen_root = "demo/doxygen"
 doxysphinx_enabled = True
 doxygen_project = {

diff --git a/src/rocm_docs/data/projects.yaml b/src/rocm_docs/data/projects.yaml
@@ -29,6 +29,12 @@ projects:
     development_branch: master
   miopen: https://rocm.docs.amd.com/projects/MIOpen/en/${version}
   mivisionx: https://rocm.docs.amd.com/projects/MIVisionX/en/${version}
+  omniperf:
+    target: https://rocm.docs.amd.com/projects/omniperf/en/${version}
+    development_branch: main
+  omnitrace:
+    target: https://rocm.docs.amd.com/projects/omnitrace/en/${version}
+    development_branch: main
   python: https://docs.python.org/3/
   rccl: https://rocm.docs.amd.com/projects/rccl/en/${version}
   rdc: https://rocm.docs.amd.com/projects/rdc/en/${version}

diff --git a/tests/sites/doxygen/extension/conf.py b/tests/sites/doxygen/extension/conf.py
@@ -2,8 +2,8 @@
 extensions = ["rocm_docs", "rocm_docs.doxygen", "sphinxcontrib.doxylink"]
 
 doxygen_project = {
-    "name": "Rocm Docs Core Doxygen Legacy Test Project",
-    "path": ".doxygen/docBin/xml",
+    "name": "ROCm Docs Core Test Project - Extension",
+    "path": "doxygen/xml",
 }
 doxysphinx_enabled = True
 

diff --git a/tests/sites/doxygen/legacy/conf.py b/tests/sites/doxygen/legacy/conf.py
@@ -1,8 +1,8 @@
 from rocm_docs import ROCmDocs
 
-docs_core = ROCmDocs("Rocm Docs Core Doxygen Legacy Test Project")
+docs_core = ROCmDocs("ROCm Docs Core Doxygen Test Project - Legacy")
 docs_core.setup()
-docs_core.run_doxygen()
+docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
 docs_core.enable_api_reference()
 
 for sphinx_var in ROCmDocs.SPHINX_VARS:

diff --git a/tests/sites/pass/minimal_legacy/conf.py b/tests/sites/pass/minimal_legacy/conf.py
@@ -1,6 +1,6 @@
 from rocm_docs import ROCmDocs
 
-docs_core = ROCmDocs("ROCm Docs Core")
+docs_core = ROCmDocs("ROCm Docs Core Test Project - Minimal Legacy")
 docs_core.setup()
 
 for sphinx_var in ROCmDocs.SPHINX_VARS: