From 128250da9f91962447e03f7ac2574995cdc59880 Mon Sep 17 00:00:00 2001 From: Jesse Mapel <jmapel@usgs.gov> Date: Wed, 17 Mar 2021 14:58:28 -0700 Subject: [PATCH] Update conf.py (#407) --- docs/conf.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0d0f1ab..86063ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,10 @@ # 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 sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +import subprocess +sys.path.insert(0, os.path.abspath('../ale')) # -- Project information ----------------------------------------------------- @@ -30,7 +31,7 @@ release = 'ale.__version__' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autodoc'] +extensions = ['sphinx.ext.autodoc', 'breathe'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -57,9 +58,13 @@ html_theme = 'alabaster' html_static_path = ['_static'] # -- Run Doxygen for C++ API -------------------------------------------------- -import subprocess, os read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: subprocess.call('doxygen', shell=True) + +# -- Breathe Configuration ---------------------------------------------------- + +breathe_projects = { "ALE": "doxyxml/" } +breathe_default_project = "ALE" -- GitLab