Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new doc projects and update rocm-docs-core docs #842

Merged
merged 3 commits into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
6 changes: 6 additions & 0 deletions src/rocm_docs/data/projects.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
4 changes: 2 additions & 2 deletions tests/sites/doxygen/extension/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions tests/sites/doxygen/legacy/conf.py
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion tests/sites/pass/minimal_legacy/conf.py
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Loading