sphinx (or other means to document python)

Dan Stromberg drsalists at gmail.com
Mon Oct 24 17:28:09 EDT 2016


On Sat, Sep 24, 2016 at 6:30 PM, Yann Kaiser <kaiser.yann at gmail.com> wrote:
> 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.

I just evaluated a bunch of docstring-extracting-for-documentation
tools, including Sphinx and pydoctor.

Sphinx isn't that hard anymore, with autodoc and apidoc.

But pydoctor appears to be Python 2.x only - that's a problem in 2016.
Please correct me if I'm wrong.



More information about the Python-list mailing list