From 93660a26af1bc6457bdf110538160e9ae1238d1b Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 4 Feb 2017 17:15:39 +0000 Subject: [PATCH] Fix missing class and member names in docs Due to an incompatibility between Sphinx 1.5.x and Breathe 4.4, pin the sphinx version to 1.4.9 and update the README to include how to install it. --- README.md | 3 ++- docs/api/requirements.txt | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 123992c4..068525b7 100644 --- a/README.md +++ b/README.md @@ -55,9 +55,10 @@ The GUI's HTML file is automatically built when building the LOOT GUI binary, bu ## Building The Documentation -The documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/), [Breathe](https://breathe.readthedocs.io/en/latest/) and [Sphinx](http://www.sphinx-doc.org/en/stable/). Install them (Breathe and Sphinx support Python 2 and 3) and make sure they're accessible from your `PATH`, then run: +The documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/), [Breathe](https://breathe.readthedocs.io/en/latest/) and [Sphinx](http://www.sphinx-doc.org/en/stable/). Install Doxygen and Python (2 or 3) and make sure they're accessible from your `PATH`, then run: ``` +pip install -r docs/api/requirements.txt sphinx-build -b html docs build/docs/html ``` diff --git a/docs/api/requirements.txt b/docs/api/requirements.txt index cd6467ed..b98be4a2 100644 --- a/docs/api/requirements.txt +++ b/docs/api/requirements.txt @@ -1 +1,3 @@ +sphinx==1.4.9 +sphinx_rtd_theme breathe