From 0b82eadc6e949f564bbb4835a2f8a0a25893e7dc Mon Sep 17 00:00:00 2001 From: Sander Vrijders Date: Thu, 5 Apr 2018 09:42:45 +0200 Subject: doc: Update docs with feedback from Miguel This updates the docs with some feedback from Miguel. It should help make the documentation easier to follow. --- doc/installation.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/installation.rst') diff --git a/doc/installation.rst b/doc/installation.rst index c2038d0..1507cee 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -19,3 +19,17 @@ To install the latest version from source, clone the repository and install it from the command line: :: $ python setup.py install + +Generating the documentation +--------------------------------- + +To generate the documentation, run the following command in the root +folder of the repository: :: + + $ sphinx-build doc/ public/ + +This will generate HTML pages in the public/ folder. Other output +formats are possible by using a different 'builder', the following +command would for instance generate LaTeX files: :: + + $ sphinx-build -b latex doc/ latex/ -- cgit v1.2.3