How to make doc generator accept restructuredText and Sphinx parameter format?

Asked by Teemu Y on 2012-05-30

Hi,

We are using Sphinx, including sphinx-apidoc, to generate documentation for our codebase, as that seems to be the current recommendation. The Ladon modules' Sphinx-generated output is obviously unreadable enough to be useless.

What would I need to change in Ladon to switch the docstring format that Ladon's documentation generator accepts to match that of Sphinx?

Thanks.

http://sphinx.pocoo.org/man/sphinx-apidoc.html

Question information

Language:
English Edit question
Status:
Answered
For:
ladon Edit question
Assignee:
No assignee Edit question
Last query:
2012-05-30
Last reply:
2012-06-07
jsgaarde (jakob-simon-gaarde) said : #1

Hi Teenu.

I am gonna do some Sphinx integration this week. I will get back to you.

/ Jakob

jsgaarde (jakob-simon-gaarde) said : #2

Hi Teemu

take a look at the newest version of Ladon ;-)

http://pypi.python.org/pypi/ladon

/ Jakob

Can you help with this problem?

Provide an answer of your own, or ask Teemu Y for more information if necessary.

To post a message you must log in.