From fc8a36438d8ccd0616446aea0f8e828f5981069c Mon Sep 17 00:00:00 2001
From: Tim Stadtmann <tim.stadtmann@rwth-aachen.de>
Date: Tue, 26 Sep 2017 21:30:44 +0200
Subject: [PATCH] Update readme.md

---
 readme.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/readme.md b/readme.md
index beddf3c..e2f72d4 100644
--- a/readme.md
+++ b/readme.md
@@ -70,5 +70,33 @@ and *doc functionname/classname*, or in the generated PDF/HTML documentation (in
 TODO
 
 ### 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
+```
+
 
 
-- 
GitLab