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

Use the same sphinx config for dev and Read The Docs

Browse Source
This commit is contained in:
Oliver Hamlet
2016-09-19 20:49:29 +01:00
parent bc9f370917
commit f0bd3e0e1a
2 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -2
View File
@@ -55,10 +55,9 @@ 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:
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:
```
doxygen docs/api/Doxyfile
sphinx-build -b html docs build/docs/sphinx
```
docs/conf.py
+4 -7
View File
@@ -22,14 +22,11 @@
import subprocess, os
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
output_directory = os.path.join('..', 'build', 'docs')
if not os.path.exists(output_directory):
os.makedirs(output_directory)
if read_the_docs_build:
output_directory = '../build/docs'
if not os.path.exists(output_directory):
os.makedirs(output_directory)
subprocess.call('doxygen', shell=True, cwd='..')
subprocess.call(['doxygen', 'docs/api/Doxyfile'], cwd='..')
# -- General configuration ------------------------------------------------