From 2e78110991b1a5f218ff891ca101bc7cecda6ff2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 3 Jan 2020 14:39:05 -0800 Subject: [PATCH] turn off doxygen for now --- docs/conf.py | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f235c866..7da2f495 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,7 @@ # 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. # -# import os +import os # import sys # sys.path.insert(0, os.path.abspath('.')) @@ -28,9 +28,9 @@ author = 'Keyboardio & Friends' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'breathe', - 'exhale' - + # 'breathe', + # 'exhale', + 'recommonmark' ] @@ -45,14 +45,15 @@ exhale_args = { # These arguments are required "containmentFolder": "./api", "rootFileName": "library_root.rst", - "rootFileTitle": "Kaleidoscope API", + "rootFileTitle": "Kaleidoscope", "doxygenStripFromPath": "..", # Suggested optional arguments - "createTreeView": True, + "createTreeView": False, # TIP: if using the sphinx-bootstrap-theme, you need # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": True, - "exhaleDoxygenStdin": "INPUT = ../include" + "exhaleExecutesDoxygen": False, + "exhaleDoxygenStdin": "INPUT = ../src", + "verboseBuild": True } # 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 # 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, # relative to this directory. They are copied after the builtin static files,