Standardize documentation for ReadtheDocs

Relates to https://github.com/RadeonOpenCompute/rocm-docs-core/issues/330

Change-Id: Ic9370548bb8d919376b20f7e1800fe620369e69b
This commit is contained in:
Sam Wu authored and Sam Wu committed 2023-12-08 16:56:59 -05:00
1 parent ed3cfffd7e
commit 5890852ff1
11 files changed
+105 -95

No files matched your search

-1
View File
@@ -1 +0,0 @@
rocm-docs-core==0.11.0
+11 -1
View File
@@ -6,9 +6,19 @@
from rocm_docs import ROCmDocs
# for PDF output on Read the Docs
project = "ROCm Data Center Documentation"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
external_toc_path = "./sphinx/_toc.yml"
docs_core = ROCmDocs("ROCm Data Center Documentation")
docs_core.run_doxygen()
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
docs_core.setup()
external_projects_current_project = "rdc"
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
+2
View File
@@ -0,0 +1,2 @@
html/
xml/
@@ -61,7 +61,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
+4
View File
@@ -0,0 +1,4 @@
# License
```{include} ../LICENSE
```
@@ -17,3 +17,6 @@ subtrees:
- caption: API Reference
entries:
- file: api_ref
- caption: About
entries:
- file: license
+1
View File
@@ -0,0 +1 @@
rocm-docs-core==0.28.0
@@ -54,8 +54,6 @@ jinja2==3.1.2
# via
# myst-parser
# sphinx
linkify-it-py==1.0.3
# via myst-parser
markdown-it-py==2.2.0
# via
# mdit-py-plugins
@@ -66,7 +64,7 @@ mdit-py-plugins==0.3.5
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
myst-parser[linkify]==1.0.0
myst-parser==1.0.0
# via rocm-docs-core
packaging==23.0
# via
@@ -100,7 +98,7 @@ requests==2.28.2
# via
# pygithub
# sphinx
rocm-docs-core==0.11.0
rocm-docs-core==0.28.0
# via -r requirements.in
smmap==5.0.0
# via gitdb
@@ -143,8 +141,6 @@ sphinxcontrib-serializinghtml==1.1.5
# via sphinx
typing-extensions==4.5.0
# via pydata-sphinx-theme
uc-micro-py==1.0.1
# via linkify-it-py
urllib3==1.26.15
# via requests
wrapt==1.15.0