[FM Discuss] Fwd: [Baypiggies] Beautiful Documentation with Sphinx

[Janet Swisher]

A few more things:

Sphinx is being used to produce the official documentation for Python
2.6 and later: http://docs.python.org/

This replaces the previous LaTeX-based docs: http://www.python.org/doc/2.5/

I wrote a blog post about how I'm using Sphinx to generate exercise
handouts for Python training classes:
http://www.janetswisher.com/?itemid=198

Doug Hellman uses Sphinx as part of his workflow for his Python Module
of the Week series:
http://broadcast.oreilly.com/2009/02/writing-technical-documentatio.html


On Wed, Mar 11, 2009 at 8:15 AM, Janet Swisher <jmswisher at gmail.com> wrote:
> Yes, I use it at work. It's becoming more and more widespread in the
> Python world. Docutils and ReStructured Text have been around for a
> long time, but Sphinx is the killer app that makes creating
> documentation easy for programmers, because they can write in plain
> text with simple mark-up, and get attractive, styled output.
>
> Fernando Perez is the guy behind the IPython interpreter shell. I
> highly recommend going to this talk if you can make it. If you get a
> chance, tell him Janet sends greetings from Enthought.
>
> --Janet
>
>
> On Wed, Mar 11, 2009 at 4:34 AM, Edward Cherlin <echerlin at gmail.com> wrote:
>> Anybody know anything about creating documentation in Sphinx? It comes
>> under a BSD license, with HTML and LaTeX output.
>>
>>
>> ---------- Forwarded message ----------
>> From: Glen Jarvis <glen at glenjarvis.com>
>> Date: Fri, Mar 6, 2009 at 8:33 PM
>> Subject: [Baypiggies] Beautiful Documentation with Sphinx
>> To: Baypiggies <baypiggies at python.org>
>>
>>
>> There was an earlier thread where I was struggling getting Sphinx
>> setup so I could test how my documentation of code in rich text would
>> look both in code and in documentation tools like Sphinx. Jim even
>> suggested I bring this as a newbie nugget. I'm still struggling and
>> learning. But, there is a tech talk at the Py4Science group in
>> Berkeley:
>> This came from a recent posting from Paul Ivanov (from Py4Science).
>> The meeting is this next week:
>>
>> The py4science group consists of a bunch of UC Berkeley users who are
>> interested in using, learning about and developing Python-based tools
>> for scientific research. While our initial focus was in projects useful
>> to neuroscience (the group was started by fellows from the Redwood and
>> Helen Wills neuroscience institutes on campus), we hope to bring
>> together a wider audience of users on campus from all disciplines.
>>
>> Next meeting: March 11th. Fernando Perez: creating intelligent and
>> beautiful documentation with Sphinx.
>>
>> All meetings are held on Wednesdays at 4pm, 508-20 Evans Hall, every two
>> weeks.
>>
>> Please see the website for a summary of past topics covered, as well as
>> information about the listserve.
>>
>> <https://cirl.berkeley.edu/view/Py4Science>
>>
>> cheers,
>> Paul Ivanov
>>
>>