loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fix missing class and member names in docs

Browse Source 
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.
This commit is contained in:
Oliver Hamlet
2017-02-06 18:03:18 +00:00
parent 26a6b42cad
commit 93660a26af
2 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -1
View File
@@ -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
```
docs/api/requirements.txt
+2
View File
@@ -1 +1,3 @@
sphinx==1.4.9
sphinx_rtd_theme
breathe