2020-10-24 14:48:03 +02:00
|
|
|
# The `extensions` list should already be in here from `sphinx-quickstart`
|
|
|
|
|
extensions = [
|
|
|
|
|
# there may be others here already, e.g. 'sphinx.ext.mathjax'
|
|
|
|
|
'breathe',
|
|
|
|
|
'exhale',
|
|
|
|
|
'sphinx.ext.intersphinx'
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
project = u'IfcOpenShell'
|
|
|
|
|
copyright = u'2020, IfcOpenShell'
|
|
|
|
|
author = u'Johan Luttun'
|
|
|
|
|
|
|
|
|
|
# Setup the breathe extension
|
|
|
|
|
breathe_projects = {
|
2020-11-01 12:13:54 +01:00
|
|
|
"My Project": "./doxygen/xml"
|
2020-10-24 14:48:03 +02:00
|
|
|
}
|
|
|
|
|
breathe_default_project = "My Project"
|
|
|
|
|
|
|
|
|
|
# Setup the exhale extension
|
|
|
|
|
exhale_args = {
|
|
|
|
|
# These arguments are required
|
|
|
|
|
"containmentFolder": "./rst_files",
|
|
|
|
|
"rootFileName": "library_root.rst",
|
|
|
|
|
"rootFileTitle": "IfcOpenShell",
|
|
|
|
|
"doxygenStripFromPath": "..",
|
|
|
|
|
# Suggested optional arguments
|
|
|
|
|
"createTreeView": True,
|
|
|
|
|
# TIP: if using the sphinx-bootstrap-theme, you need
|
|
|
|
|
# "treeViewIsBootstrap": True,
|
|
|
|
|
"exhaleExecutesDoxygen": True,
|
2020-10-31 15:20:35 +01:00
|
|
|
"exhaleDoxygenStdin": "INPUT = ../src/serializers/"
|
2020-10-24 14:48:03 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# html_theme = 'sphinx_rtd_theme'
|
|
|
|
|
|
|
|
|
|
# Tell sphinx what the primary language being documented is.
|
|
|
|
|
primary_domain = 'cpp'
|
|
|
|
|
|
|
|
|
|
# Tell sphinx what the pygments highlight language should be.
|
|
|
|
|
highlight_language = 'cpp'
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|