Comments on: Use Sphinx for documentation

By: CG Hijinks » Script Repo Help: Using TiddlyWiki for Mel & Python Documentation

Mon, 17 Jan 2011 05:20:49 +0000

[...] http://scienceoss.com/use-sphinx-for-documentation/ [...]

By: Blaz

Blaz — Fri, 16 Jul 2010 11:13:25 +0000

I have just started with Sphinx, your blog was the first thing I read – very nice, thanks!

By: ryan

ryan — Thu, 15 Apr 2010 03:02:15 +0000

I just wrote a post on the minimum setup you need to use Sphinx to autodocument your code, hopefully this will help:

http://scienceoss.com/minimal-sphinx-setup-for-autodocumenting-python-modules/

By: Michael

Michael — Tue, 06 Apr 2010 16:45:44 +0000

I am also interested in a minimal introduction to automatic documentation generation from docstrings. If I figure it out I suppose I will write something .. this needs to exist. The Sphinx documentation is confusing to me, and so I assume other beginners are also swearing at their computers trying to figure this out.

By: Bruce

Bruce — Mon, 18 Jan 2010 22:20:29 +0000

I too would be interested in more info about auto-generating from existing doc strings. Its ironic how a documentation product such as sphinx doesn’t seem to have a decent basic tutorial which covers this key aspect !

By: Ciantic

Ciantic — Sat, 09 Jan 2010 15:30:32 +0000

Yes, more about auto generating from docstrings… Since most of the projects in Python are small, where docstrings are almost the only documentation needed.

I’m in search for example of almost only auto-generated tutorial at the moment.

By: Michael Wilson

Michael Wilson — Thu, 01 Oct 2009 03:51:46 +0000

Interesting the lack of decent beginners tutorials for Sphinx… Thanks!

By: Tom Counsell

Tom Counsell — Fri, 11 Sep 2009 17:19:51 +0000

Thanks so much! very helpful!

By: Simone Ribeiro

Simone Ribeiro — Mon, 03 Aug 2009 20:40:08 +0000

Really really wonderful.

Thank you very much. I helps A LOT!!!!

Simone

By: ryan

ryan — Fri, 17 Jul 2009 02:49:21 +0000

Once sphinx.ext.autodoc is in the extensions list, you need to put a directive in your documentation where you want your docstrings to show up. For example, to pull in all the docstrings of your module, put this in your .rst file:

.. automodule::

The following should help get you started until I have more time to edit this post:

http://sphinx.pocoo.org/ext/autodoc.html