» Main »
sphinx - Python documentation generator
Published by Tim Cuthbertson
- Overview
This is a Zero Install feed. To add this program to your Applications menu, choose Zero Install -> Add New Program from the Applications menu. e.g. on Ubuntu:
If you don't see this menu item, install the zeroinstall-injector package from your distribution's repository, or from 0install.net.
Drag the feed's URL to the dialog box that appears. Other environments may use other systems. For example, if you are a ROX desktop user, drag the link to AddApp instead.
Alternatively, to run it from the command-line:
$ 0launch http://gfxmonk.net/dist/0install/sphinx.xml
The 0alias command can be used to create a short-cut to run it again later.
If you don't have the 0launch command, download it from the 0install.net web-site, which also contains documentation about how the Zero Install system works.
- Full name
- Description
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. 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. Among its features are the following: - Output formats: HTML (including derivative formats such as HTML Help, Epub and Qt Help), plain text, manual pages and LaTeX or direct PDF output using rst2pdf - 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 - Flexible HTML output using the Jinja 2 templating engine - Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings - Setuptools integration
- Homepage
- Available versions
The list below is just for information; Zero Install will automatically select one of these versions for you.
Version Released Stability Platform Download 1.1.3 2012-03-28 Any Download (2632059 bytes) Non-Zero Install packages provided distributions can also provide this interface:
Distribution Package name python-sphinx - Required libraries
The list below is just for information; Zero Install will automatically download any required libraries for you.