Dokumentation¶
- Die Dokumentation ist mit sphinx, javasphinx
- und Javadoc erstellt wordenden.
Gehostet wird die Dokumentation auf readthedocs.org welches durch ein Github hook mit jeden Push automatisch aktualisiert wird.
Dokumentation bearbeiten¶
Die Dokumentation Quelldaten befinden sich in den Ordner /docs/source und sind in reStructuredText Format geschrieben. Nach dem bearbeiten der Quelldaten müssen diese noch in HTML konvertiert werden, dieses wird über das Shell Script /docs/javasphinx.sh erledigt.
Dokumentation aktualisieren¶
Es wurde für Ubuntu 12.04, 14.04 und 16.04 mit Python 3 ein Shell Script zur automatischen konvertierung von Javadoc und reStructuredText Datein zur HTML integrierd, auf welches readthedocs.org zugreift sobald ein push auf Github gesendet wird.
Abhänigkeiten installieren¶
$ sudo apt-get build-dep python-lxml
$ sudo apt-get install texlive-full
Nur für Ubuntu 12.04 und 14.04
$ sudo apt-get install python-virtualenv
Für Ubuntu 16.04
$ sudo apt-get install python3-venv
Virtualenv anlegen und verwenden¶
wichtig >> folgene 2 Befehle im Wurzelverzeichnis des Projektes ausführen!
Virtualenv für Python 3 anlegen
$ virtualenv -p python3 env
In virtuelle Umgebung einloggen
$ source env/bin/activate
Python abhänigkeiten installieren¶
$ pip install -r docs/requirements.txt
Dokumentation erzeugen¶
Im Unterverzeichnis /docs wechseln und das Script javaspinx.sh ausführen
$ ./javasphinx.sh
Sobald das Script erfolgreich ausgeführt wurde sind in den Order /docs/build/ die Aktuelle Dokumentation in verschiedenen Formaten zu finden.
Dokumentation alternative Formate¶
Es ist über die Makefile in /docs wird die Dokumentation in mehreren Formaten ausgegeben:
- EPUB –> /docs/build/epub/PolynomialsCalculator.epub
- epub3 –> /docs/build/epub3/PolynomialsCalculator.epub
- latex –> /docs/build/latex/
- PDF –> /docs/build/latex/PolynomialsCalculator.pdf
- man –> /docs/build/man/polynomialscalculator.1