diff --git a/README.md b/README.md index 37494b06..7db8996a 100644 --- a/README.md +++ b/README.md @@ -53,16 +53,13 @@ You may also need to set `BOOST_ROOT` if CMake cannot find Boost. The GUI's HTML file is automatically built when building the LOOT GUI binary, but it can also be built by running `node scripts/vulcanize.js` from the repository root. -## Building The API Documentation +## Building The Documentation -The API 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/). On Windows, install Doxygen and [Python](https://www.python.org) 2.7, add Doxygen's binary path, `C:\Python27` and `C:\Python27\Scripts` (or wherever you installed Python to) to 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: ``` -python -m pip install breathe sphinx -cd docs/api -doxygen -cd ../.. -sphinx-build -b html docs build/documentation/sphinx +doxygen docs/api/Doxyfile +sphinx-build -b html docs build/docs/sphinx ``` ## Packaging Releases diff --git a/docs/api/Doxyfile b/docs/api/Doxyfile index 7591b5b8..30827ce3 100644 --- a/docs/api/Doxyfile +++ b/docs/api/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = C:/Users/Oliver/Documents/GitHub/LOOT/loot/resources/ic # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ../../build/documentation +OUTPUT_DIRECTORY = build/docs # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -781,7 +781,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../include/loot +INPUT = include/loot # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/conf.py b/docs/conf.py index 12b84155..9695f4d3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ import subprocess, os read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - output_directory = '../build/documentation' + output_directory = '../build/docs' if not os.path.exists(output_directory): os.makedirs(output_directory) @@ -353,7 +353,7 @@ texinfo_documents = [ breathe_projects = { -"loot":"../build/documentation/xml/", +"loot":"../build/docs/xml/", } breathe_default_project = 'loot'