diff options
| author | Sander Vrijders <sander.vrijders@ugent.be> | 2018-05-28 16:14:42 +0200 |
|---|---|---|
| committer | Sander Vrijders <sander.vrijders@ugent.be> | 2018-05-28 16:14:42 +0200 |
| commit | be24b0f8b90d73de3e8032361d3031af6161199c (patch) | |
| tree | 5058598e8c391cb86c79c503c9ab39bd49af13e1 /doc | |
| parent | 2f09bda1f8fe72660ef4799af37b035655067336 (diff) | |
| download | rumba-be24b0f8b90d73de3e8032361d3031af6161199c.tar.gz rumba-be24b0f8b90d73de3e8032361d3031af6161199c.zip | |
doc: Add note on generation of documentation
This states clearly that Rumba must be installed before generating the
documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installation.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/installation.rst b/doc/installation.rst index 1507cee..27c008b 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -23,8 +23,9 @@ install it from the command line: :: Generating the documentation --------------------------------- -To generate the documentation, run the following command in the root -folder of the repository: :: +To generate the documentation, make sure that you have installed +Rumba. Then, run the following command in the root folder of the +repository: :: $ sphinx-build doc/ public/ |