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