Mailman 3 March 2008 - Doc-SIG

sphinx bug
by Ondrej Certik March 24, 2008

March 24, 2008

Hi, first, let me apologize, if this is not the correct mailinglist to ask. Is there some mailinglist for the Sphinx project? http://sphinx.pocoo.org/ I tried to go to the #python-docs channel, but it doesn't exist. Anyway, the project is great. We moved the docs in ipython to it and we are going to move sympy docs as well. We found a bug though. If python-pygments isn't installed, sphinx doesn't say anything, "make latex" hapilly generate a latex file, but this latex file fails to compile: ! Undefined control sequence. <argument> In \lb []1\rb []: from ipython1.kernel import client l.1205 ...rb[]: from ipython1.kernel import client That's because the latex file is missing some definitions, like \lb, that only get included when python-pygments is installed. Do you think the file sphinx/highlighting.py line 30 could be fixed to emit a large warning message, that the latex output will be broken (possibly with an explanation of the problem)? That way one can easily spot it and fix it. Actually it took my 45 minutes of debugging with winpdb to figure out what's wrong, because I had one computer where it worked and another where it didn't. I compared all Debian latex packages on both, but it didn't occur to me the problem could by in missing pygments. But I am glad I figured this out. :) Thanks a lot, Ondrej

2 4

Sphinx released to PyPI
by Georg Brandl March 21, 2008

March 21, 2008

I'm delighted to announce that the Sphinx library, used to build the new Python documentation (for 2.6 and 3.0) [1], is now released for general use. What is it? =========== Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Its website is at <http://sphinx.pocoo.org/>. What does it do? ================ Sphinx is not an API documentation generator like Epydoc. Instead, its focus is on hand-written documentation, such as the Python one. * Main output formats: HTML (including HTML Help) and LaTeX * Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information * Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children * Automatic indices: general index as well as a module index * Code handling: automatic highlighting using the Pygments highlighter * Goodies such as changes overview, and external link checking What else? ========== Various extensions are available and in development: * autodoc: pulls in documentation from docstrings that are written in reST, to avoid having to maintain multiple documentation locations * doctest: automatically tests snippets in the documentation in doctest fashion * coverage: documentation coverage checker Cheers, Georg [1] http://docs.python.org/dev -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.

1 0

Standalone Sphinx
by Joe Gregorio March 8, 2008

March 8, 2008

I'd like to document httplib2[1] using Sphinx as a step toward getting it into the standard library. When I searched the archives I only found a message from last September[2] that indicated it wasn't separable from Python 2.6/3.0 yet. Is that still the case? Thanks, -joe [1] http://code.google.com/p/httplib2 [2] http://mail.python.org/pipermail/doc-sig/2007-September/003660.html -- Joe Gregorio http://bitworking.org

2 1