Javadoc Sphinx Dokumentation

Automatesierte Dokumentation

Javadoc Sphinx Dokumentation

Einleitung

Mittels Javadoc und Sphinx ist es möglich hochwertige Dokumentation an zu fertigen in mutiplen ausgaben Formaten wie PDF, Latex, Manuel oder HTML. Mittels readthedocs.org.

Beispiel: http://polynomials-calculator.readthedocs.io/de/latest/docs.html

Template: https://github.com/linuxluigi/javadoc-example

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 sphinx sphinx-autobuild sphinx_rtd_theme javasphinx

Docs anlegen und Sphinx-Quickstart

Docs Ordner anlegen und in das Verzeichnis wechseln.

mkdir docs
cd docs

Dokumentation anlegen mit Sphinx-Quickstart. Genauere Informationen in den YouTube Video IMAGE ALT TEXT HERE

sphinx-quickstart

config.py

Eine vorgefertigete config.py nehmen und sie Editieren: config.py

Script zum konvertieren aus RST files und Javadoc zu HTML & PDF

In den Ordner /docs/ gehen und javasphinx.sh downloaden.

wget https://github.com/linuxluigi/javadoc-example/blob/master/docs/javasphinx.sh

Mit den Editor deiner wahl bearbeiten und Variablen bestimmen.

TITEL="MyProject"
PACKAGENAME="com.example.MyProject"
SOURCE="../src/main/java/"

Danach das Script ausführen.

chmod +x javasphinx.sh
./javasphinx.sh

Wenn alles geklappt hat ist in den Build Ordner die HTML, PDF, Latex, etc ausgegeben.