| rev |
line source |
|
Hans-G?nter@25241
|
1 Sphinx is a tool that makes it easy to create intelligent and beautiful
|
|
Hans-G?nter@25241
|
2 documentation for Python projects (or other documents consisting of multiple
|
|
Hans-G?nter@25241
|
3 reStructuredText sources), written by Georg Brandl.
|
|
Hans-G?nter@25241
|
4 It was originally created for the new Python documentation, and has excellent
|
|
Hans-G?nter@25241
|
5 facilities for Python project documentation, but C/C++ is supported as well,
|
|
Hans-G?nter@25241
|
6 and more languages are planned.
|
|
Hans-G?nter@25241
|
7
|
|
Hans-G?nter@25241
|
8 Sphinx uses reStructuredText as its markup language, and many of its strengths
|
|
Hans-G?nter@25241
|
9 come from the power and straightforwardness of reStructuredText and its parsing
|
|
Hans-G?nter@25241
|
10 and translating suite, the Docutils.
|
|
Hans-G?nter@25241
|
11
|
|
Hans-G?nter@25241
|
12 Among its features are the following:
|
|
Hans-G?nter@25241
|
13
|
|
Hans-G?nter@25241
|
14 - Output formats: HTML (including derivative formats such as HTML Help, Epub
|
|
Hans-G?nter@25241
|
15 and Qt Help), plain text, manual pages and LaTeX or direct PDF output using
|
|
Hans-G?nter@25241
|
16 rst2pdf
|
|
Hans-G?nter@25241
|
17 - Extensive cross-references: semantic markup and automatic links for functions,
|
|
Hans-G?nter@25241
|
18 classes, glossary terms and similar pieces of information
|
|
Hans-G?nter@25241
|
19 - Hierarchical structure: easy definition of a document tree, with automatic
|
|
Hans-G?nter@25241
|
20 links to siblings, parents and children
|
|
Hans-G?nter@25241
|
21 - Automatic indices: general index as well as a module index
|
|
Hans-G?nter@25241
|
22 - Code handling: automatic highlighting using the Pygments highlighter
|
|
Hans-G?nter@25241
|
23 - Flexible HTML output using the Jinja 2 templating engine
|
|
Hans-G?nter@25241
|
24 - Various extensions are available, e.g. for automatic testing of snippets and
|
|
Hans-G?nter@25241
|
25 inclusion of appropriately formatted docstrings
|
|
Hans-G?nter@25241
|
26 - Setuptools integration
|