Skip to content
Snippets Groups Projects
Commit fc8a3643 authored by Tim Stadtmann's avatar Tim Stadtmann
Browse files

Update readme.md

parent 06daf8ad
Branches
No related tags found
No related merge requests found
...@@ -70,5 +70,33 @@ and *doc functionname/classname*, or in the generated PDF/HTML documentation (in ...@@ -70,5 +70,33 @@ and *doc functionname/classname*, or in the generated PDF/HTML documentation (in
TODO TODO
### Building the documentation ### ### Building the documentation ###
The documentation is built using [Sphinx](http://www.sphinx-doc.org/en/stable/) and several
extensions: [matlabdomain](https://pypi.python.org/pypi/sphinxcontrib-matlabdomain),
[Napoleon](https://pypi.python.org/pypi/sphinxcontrib-napoleon) and
[Sphinx Bootstrap Theme](https://pypi.python.org/pypi/sphinx-bootstrap-theme/).
In order to setup your PC for building the documentation from the comments, you need to install these.
Using Ubuntu, you can use the following instructions (for other distros/OS's checkout the websites above):
```
sudo apt-get install python-sphinx
pip install sphinxcontrib-napoleon
pip install -U sphinxcontrib-matlabdomain
pip install sphinx_bootstrap_theme
```
You also need to setup your latex parser if you want Sphinx to generate pdfs:
```
sudo apt install texlive-latex-base
sudo apt install texlive-latex-extra
```
The build process for different outputs/platforms is controlled with a Makefile.
In the doc-directory, use the following commands to generate html or pdf files.
Other targets have not been tested.
```
make html
make latexpdf
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment