Skip to content
Snippets Groups Projects

Merge v0.10

Merged Tuan Duong Quang requested to merge develop into main
293 files
+ 12412
2152
Compare changes
  • Side-by-side
  • Inline
Files
293
@@ -17,6 +17,7 @@ from sphinx.directives.other import TocTree
class ARGS:
"""Default argument values"""
API_DOC_BUILD_DEACTIVATED = "off"
DEFAULT_API_DOC_ROOT = "../../../sim"
DEFAULT_API_DOC_BUILD = API_DOC_BUILD_DEACTIVATED
DEFAULT_API_DOC_PATH = "api"
DEFAULT_API_DOC_TITLE = "Source Code Documentation"
@@ -48,15 +49,15 @@ def on_config_inited(app, config):
# These arguments are required
"containmentFolder": f"./{config.api_doc_path}",
"rootFileName": "index.rst",
"rootFileTitle": f"{config.api_doc_title}",
"doxygenStripFromPath": "../../../sim",
"rootFileTitle": config.api_doc_title,
"doxygenStripFromPath": config.api_doc_root,
# Suggested optional arguments
"createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": dedent('''
INPUT = ../../../sim/src
"exhaleDoxygenStdin": dedent(f'''
INPUT = {config.api_doc_root}/src
WARN_IF_UNDOCUMENTED = NO
WARN_AS_ERROR = NO
PREDEFINED += DOXYGEN_SHOULD_SKIP_THIS
@@ -136,6 +137,8 @@ def setup(app):
app.add_directive(ApiDoc.API_DOC_DIRECTIVE, ApiDoc)
app.add_config_value(name='api_doc_root',
default=ARGS.DEFAULT_API_DOC_ROOT, rebuild='env')
app.add_config_value(name='api_doc_build',
default=ARGS.DEFAULT_API_DOC_BUILD, rebuild='env')
app.add_config_value(name='api_doc_path',
Loading