Python: Generating HTML output documentation based on Docstring

Question

Is there a way to easily output html documentation based on python docstrings?

If there are, how to do this? I am familiar with HTML/CSS so theming the output is not important, but if there are existing themes, they would help.

I am hoping for a process that can be repeated everytime the code is updated.

Why is this question (and its answers) downvoted? – jtpereyda Nov 24 '15 at 21:36 — jtpereyda, Nov 24 '15 at 21:36

score 0 · Accepted Answer · answered Dec 27 '14 at 18:31

0

Epydoc that seems to do what you need

answered Dec 27 '14 at 18:31

pbeedgen

Thanks a lot! What I did (virtualenv was) pip install epydoc & generated html output like this: "epydoc --html app.py -o app" (html putput for app.py to a folder called 'app') – Capuchin Dec 27 '14 at 18:40
with --css parameter you can select the styling from "blue, default, grayscale, black, green, white" – Capuchin Dec 27 '14 at 18:50

score 0 · Answer 2 · answered Jul 09 '15 at 13:20

0

Sphinx is another tool that can be used to create documentation for python, it also supports C and C++.

answered Jul 09 '15 at 13:20

JamesD

2 Answers2