diff options
| author | Sander Vrijders <sander.vrijders@ugent.be> | 2018-04-05 09:42:45 +0200 |
|---|---|---|
| committer | Sander Vrijders <sander.vrijders@ugent.be> | 2018-04-05 09:48:35 +0200 |
| commit | 0b82eadc6e949f564bbb4835a2f8a0a25893e7dc (patch) | |
| tree | 267217616fc216be6ee3403f75b6f2f6b1576161 /doc/installation.rst | |
| parent | ead056b9f91c3d9c6ee56adf5fd00ee5b0889db2 (diff) | |
| download | rumba-0b82eadc6e949f564bbb4835a2f8a0a25893e7dc.tar.gz rumba-0b82eadc6e949f564bbb4835a2f8a0a25893e7dc.zip | |
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.
Diffstat (limited to 'doc/installation.rst')
| -rw-r--r-- | doc/installation.rst | 14 |
1 files changed, 14 insertions, 0 deletions
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/ |