From ef1b2ce8f5fc4d4b09ce6b67839dbea8c7dc6927 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 6 Jan 2020 22:19:29 -0800 Subject: [PATCH] attempt to turn on exhale for readthedocs. It's -really- slow. --- .gitignore | 2 ++ docs/conf.py | 8 ++++---- docs/requirements.txt | 2 ++ 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index c3621155..56ba216c 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,5 @@ /examples/*/output/ /out/ /docs/generated +/docs/doxyoutput +/docs/api diff --git a/docs/conf.py b/docs/conf.py index 476f3556..7cb2a7fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,9 +30,9 @@ author = 'Keyboardio & Friends' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - # 'breathe', - # 'exhale', - 'recommonmark' + 'breathe', + 'exhale', + 'recommonmark' ] @@ -59,7 +59,7 @@ exhale_args = { "createTreeView": False, # TIP: if using the sphinx-bootstrap-theme, you need # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": False, + "exhaleExecutesDoxygen": True, "exhaleDoxygenStdin": "INPUT = ../src", "verboseBuild": True } diff --git a/docs/requirements.txt b/docs/requirements.txt index 7b0c4710..58c9c5e5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,3 @@ +sphinx>=2.0 +breathe>=4.13.0 exhale