Wednesday, 21 August 2013

Autodocument entire python project with Sphinx

Autodocument entire python project with Sphinx

I want to generate a Spinx documentation website for my entire project.
This seems really basic but somehow it is quite complicated!
I have a well-documented python project inside a directory so everything
is like:
projectFolder:
-__init__.py
-folderA:
--__init__.py
--somefile.py
-folderB:
--__init.py
--anotherfile.py
The closest I have got is creating a sphinx project like:
$ mkdir docs
$ cd docs
$ spinx-quickstart
Then runnng:
$ sphinx-apidoc -o . /path/to/my/source/files
$ make html
This will generate a set of html files for each module with a list of
functions inside but those functions are blank.

No comments:

Post a Comment