[Sorry to sent this to a -dev list, there seems no -users list].

Hi,

I have a rather silly question:

Can I use sphinx to take Python docstrings and output reStructuredText
or some other markup?

I have a GitHub-hosted projected, and the GitHub wiki takes several
types of markup [1].

Unfortunately, sphinx-build does not seem to be able to output to any of
these formats [2].

I expected sphinx-apidoc to be able to generate reStructuredText from
the docstrings, but so far all I have been able to generate is a small
reST file with a list of the modules in my package, but not including
any content from the modules itself, let alone docstrings from all
classes and methods.

It seems that in a normal workflow sphinx-build is the process to parse
the docstrings. However, as said above, sphinx-build can not output to a
markup language, only to formats such as HTML, PDF and plain text.

Am I missing something obvious here?

If sphinx is not able to produce reStructuredText from docstrings, do
you have suggestion for a tool that is capable of doing that?

Thanks a lot,
Freek

[1] https://github.com/github/markup#readme
[2] http://sphinx.pocoo.org/invocation.html

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to