Commit f60c0917 authored by bellotti_r's avatar bellotti_r
Browse files


parent 837bce7f
......@@ -174,4 +174,17 @@ to export the path variable, i.e.
$ export PATH=/absolute/path/to/build/bin:$PATH
Generation of documentation
The Sphinx documentation of all modules, classes, functions etc. can be automatically generated by executing the following commands:
cd doc
make html
This will generate the documentation in the directory ```doc/build/```.
It can be viewed by opening ```doc/build/html/index.html``` in your browser of choice.
Building PDF documentation should also be possible, but is not tested yet.
Note: Executing `````` is only necessary if new Python modules have been added before the last build.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment