Instalace:
apt-get install python-sphinx
Poté do adresáře s vašimi zdrojáky, které chcete dokumentovat a:
sphinx-quickstart
(nastavit root jako "docs", rozdělit na source a build, pak stačí prakticky vše odentrovat, jen potvrdit autodoc; a nechte vytvořit make file) - vytvoří docs/Makefile, docs/source/ conf.py
Vlezte do adresáře "docs", měl by tam být onen conf.py a Makefile. Přidejte do něj řádku:
sys.path.insert(0,"/CESTA_K_VASIM_ZDROJAKUM_PRO_ODOKUMENTOVANI")
Potom ve složce "doce" spusťte:
sphinx-apidoc -o ./source ../ -f
Pro vytvoření html výstupu v docs/build/html/
make html
Toť vše.
Reference First Steps with Sphinx — Sphinx 1.2.1 documentation, lepší Sphinx Autodoc Tutorial for Dummies.
Tento web jsem zakládal na střední, v roce 2008. Je zde hlavně archiv mé tvorby.
Aktuální věci publikuji kvůli úspoře času na Twitter.
Honza
"Nemůžete si stanovit směr, kterým chceme jít, dokud nevíte, kde jste."