Skip to content

Commit f4a3d3f

Browse files
committed
test(legacy/conf.py): Add more vars and explanations to legacy Sphinx config
1 parent bf83b82 commit f4a3d3f

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

tests/sites/doxygen/legacy/conf.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
from rocm_docs import ROCmDocs
22

3+
# base setup for using rocm-docs-core package
34
docs_core = ROCmDocs("ROCm Docs Core Doxygen Test Project - Legacy")
45
docs_core.setup()
6+
7+
# doxygen integration
58
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
9+
10+
# doxysphinx integration
611
docs_core.enable_api_reference()
712

13+
# used in intersphinx linking
14+
external_projects_current_project = "a"
15+
16+
# custom path to table of contents
17+
external_toc_path = "./sphinx/_toc.yml"
18+
19+
# set variables from rocm-docs-core for sphinx
820
for sphinx_var in ROCmDocs.SPHINX_VARS:
921
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
1022

23+
# optional extension for additional linking to doxygen
1124
if not "extensions" in globals():
1225
extensions = []
13-
1426
extensions += ["sphinxcontrib.doxylink"]
15-
16-
external_projects_current_project = "a"

0 commit comments

Comments
 (0)