turn off doxygen for now

pull/783/head
Jesse Vincent 5 years ago
parent 965f4ce86e
commit 2e78110991
No known key found for this signature in database
GPG Key ID: CC228463465E40BC

@ -10,7 +10,7 @@
# add these directories to sys.path here. If the directory is relative to the # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
# import os import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
@ -28,9 +28,9 @@ author = 'Keyboardio & Friends'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'breathe', # 'breathe',
'exhale' # 'exhale',
'recommonmark'
] ]
@ -45,14 +45,15 @@ exhale_args = {
# These arguments are required # These arguments are required
"containmentFolder": "./api", "containmentFolder": "./api",
"rootFileName": "library_root.rst", "rootFileName": "library_root.rst",
"rootFileTitle": "Kaleidoscope API", "rootFileTitle": "Kaleidoscope",
"doxygenStripFromPath": "..", "doxygenStripFromPath": "..",
# Suggested optional arguments # Suggested optional arguments
"createTreeView": True, "createTreeView": False,
# TIP: if using the sphinx-bootstrap-theme, you need # TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True, # "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True, "exhaleExecutesDoxygen": False,
"exhaleDoxygenStdin": "INPUT = ../include" "exhaleDoxygenStdin": "INPUT = ../src",
"verboseBuild": True
} }
# Tell sphinx what the primary language being documented is. # Tell sphinx what the primary language being documented is.
@ -76,7 +77,16 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'alabaster'
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,

Loading…
Cancel
Save