# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# Search for our extensions too
import sys
sys.path.append(os.path.abspath('_ext'))
# -- Run doxygen on readthedocs.org ------------------------------------------
# Search for our extensions too
import sys
sys.path.append(os.path.abspath('_ext'))
# -- Run doxygen on readthedocs.org ------------------------------------------
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
subprocess.call('cd source; doxygen', shell=True)
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
subprocess.call('cd source; doxygen', shell=True)
breathe_default_project = "simgrid"
# Setup the exhale extension
exhale_args = {
# These arguments are required
breathe_default_project = "simgrid"
# Setup the exhale extension
exhale_args = {
# These arguments are required
- "containmentFolder": "./api",
- "rootFileName": "library_root.rst",
- "rootFileTitle": "SimGrid Full API",
- "doxygenStripFromPath": "..",
+ "containmentFolder": "./api",
+ "rootFileName": "library_root.rst",
+ "rootFileTitle": "SimGrid Full API",
+ "doxygenStripFromPath": "..",
"exhaleExecutesDoxygen": False,
# "exhaleUseDoxyfile": True,
}
"exhaleExecutesDoxygen": False,
# "exhaleUseDoxyfile": True,
}
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: ['.rst', '.md']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: ['.rst', '.md']
"gitlab_host": "framagit.org",
"gitlab_user": "simgrid",
"gitlab_repo": "simgrid",
"gitlab_host": "framagit.org",
"gitlab_user": "simgrid",
"gitlab_repo": "simgrid",
- "gitlab_version": "master", # Version
- "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
+ "gitlab_version": "master", # Version
+ "conf_py_path": "/docs/source/", # Path in the checkout to the docs root