Docs: Fix broken links, warnings and use automodule (#11)
- Fixes the broken links in rocm_smi.h - Uses automodule instead of autofunction in docs/reference/python_api.rst - Fixes some warnings during docs build - Update some of the versions in requirements.txt
This commit is contained in:
+11
-1
@@ -35,6 +35,8 @@ release = version_number
|
||||
|
||||
external_toc_path = "./sphinx/_toc.yml"
|
||||
|
||||
exclude_patterns = ['CHANGELOG.md']
|
||||
|
||||
docs_core = ROCmDocs(left_nav_title)
|
||||
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
|
||||
docs_core.enable_api_reference()
|
||||
@@ -47,4 +49,12 @@ suppress_warnings = ["etoc.toctree"]
|
||||
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
||||
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
||||
|
||||
extensions += ['sphinx.ext.mathjax']
|
||||
extensions += ['sphinx.ext.mathjax']
|
||||
|
||||
# Necessary to remove the header comments from the rocm_smi module
|
||||
def remove_module_docstring(app, what, name, obj, options, lines):
|
||||
if what == "module":
|
||||
del lines[:]
|
||||
|
||||
def setup(app):
|
||||
app.connect("autodoc-process-docstring", remove_module_docstring)
|
||||
|
||||
Reference in New Issue
Block a user