sphinx (or other means to document python)

Yann Kaiser kaiser.yann at gmail.com
Sat Sep 24 21:30:38 EDT 2016


pydoctor may be something you're looking for. I don't know if it supports
exporting to PDF like Sphinx does.

As you've no doubt figured out by now, Sphinx doesn't revolve around the
Python files themselves, but rather .rst files in which you can indeed
instruct Sphinx to just go and document a module.

On Sun, Sep 25, 2016, 02:26 <chitturk at uah.edu> wrote:

> On Sunday, September 11, 2016 at 3:56:36 PM UTC-5, chit... at uah.edu wrote:
> (about being frustrated with sphinx)
>
> I _remain_ frustrated - even as I finally figured out how to use it
> (thanks to a complete example from a friend)
>
> sphinx is very picky about spaces, lines - I had a line with some math
> formula spaces and tabs (after r''' - and sphinx kept ignoring that line
>
> when it works, the documentation (my preference is LaTeX) is great - the
> procedure for embedding the documentation as doctrings can be difficult, at
> times
>
> noweb is considerably simpler - but does not allow for the extraction
> of docstrings/comments - and does provide for a fairly painless way to
> combine comments, documentation along with code
> --
> https://mail.python.org/mailman/listinfo/python-list
>
-- 
Yann Kaiser
kaiser.yann at gmail.com
yann.kaiser at efrei.net
+33 6 51 64 01 89
https://github.com/epsy



More information about the Python-list mailing list