Everything is configured already, so it should work automatically!
The output is here:
- HTML: http://buildingsystems.readthedocs.io/en/latest/
- PDF: https://media.readthedocs.org/pdf/buildingsystems/latest/buildingsystems.pdf
The admin pages are here:
- https://readthedocs.org/projects/buildingsystems/
- https://readthedocs.org/projects/buildingsystems/builds/
To build locally, one needs Python, Sphinx, LaTeX, sphinxcontrib-bibtex and Make.
The recommended way is to install a recent Anaconda release (Python 3.x, 64 bit).
Once the installer has finished, open the Anaconda Prompt and update your installation by running:
conda update conda
conda update anaconda
conda config --append channels conda-forge
conda install future
To install the dependencies, open the Anaconda Prompt and run
conda install sphinx sphinxcontrib-bibtex sphinx_rtd_theme make
conda list
All tools that are required to generate the HTML and PDF are now installed! To generate the HTML and PDF output, open the Anaconda prompt again, and run
cd BuildingSystems\docs
make
make html
make latexpdf
make linkcheck
The output will be generated in BuildingSystems\docs\build
.
For viewing the pdf on Windows, SumatraPDF is recommended (instead of Acrobat Reader), because it does not lock the file.