|File Search||Catalog||Content Search|
Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
Although it is still under constant development, the following features are already present, work fine and can be seen "in action" in the Python docs:
* Output formats: HTML (including Windows HTML Help) and LaTeX, for printable PDF versions * 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 * Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings.
.. -*- restructuredtext -*- ================= README for Sphinx ================= Installing ========== Use ``setup.py``:: python setup.py build sudo python setup.py install Reading the docs ================ After installing:: cd doc sphinx-build . _build/html Then, direct your browser to ``_build/html/index.html``. Or read them online at <http://sphinx.pocoo.org/>. Contrib more»
sphinx-build(1) User Commands sphinx-build(1) NAME sphinx-build - Sphinx documentation generator tool SYNOPSIS sphinx-build [options] <sourcedir> <outdir> [filenames...] DESCRIPTION sphinx-build generates documentation from the files in <sourcedir> and places it in the <outdir>. sphinx-build looks for <sourcedir>/conf.py for th more»
sphinx-quickstart(1) User Commands sphinx-quickstart(1) NAME sphinx-quickstart - Sphinx documentation template generator SYNOPSIS sphinx-quickstart DESCRIPTION sphinx-quickstart is an interactive tool that asks some ques‐ tions about your project and then generates a complete docu‐ mentation directory and sample Makefile to be used wi more»
# -*- coding: utf-8 -*- """ sphinx.builders.changes ~~~~~~~~~~~~~~~~~~~~~~~ Changelog b more»
Release 0.6.6 (May 25, 2010) ============================ * Handle raw nodes in the ``text`` writer more»
# -*- coding: utf-8 -*- """ sphinx.ext.todo ~~~~~~~~~~~~~~~ Allow todos to be inserted more»
Sphinx TODO =========== All todo items are now tracked as issues in the Sphinx issue tracker at <ht more»
Sphinx is written and maintained by Georg Brandl <email@example.com>. Substantial parts of the templ more»