MH’s dev efforts

February 10, 2008

Sphinx – official Python documentation tool

Filed under: Python, programming — Tags: , , , , — mhordecki @ 1:45 pm

EDIT: Sphinx’s gone public: http://sphinx.pocoo.org/

While searching for an ideal documentation tool for build.py, i’ve checked pydoc, epydoc and many many more. Two days ago, I’ve landed on Python development version documentation site (http://docs.python.org/dev). Engine has been totally reworked (besides, new look n’ feel is simply beautiful). Now, it sits on Sphinx, which is boosted reStructuredText engine with syntax highlighting, Table of Contents generation and a bunch of another useful gadgets.

I saw it nearly perfect for my purposes, as I don’t like docstrings and I’ve had some good experiences with text markup syntax (Markdown, particularly). The only problem is, Sphinx isn’t available as a standalone package – it’s bundled with main Python branch. Hence, there’s a solution how to incorporate Sphinx into your projects.

(more…)

Blog at WordPress.com.