wok diff python-sphinx/description.txt @ rev 25466

Update some web_site
author Pascal Bellard <pascal.bellard@slitaz.org>
date Sat Oct 01 09:32:27 2022 +0000 (20 months ago)
parents
children
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/python-sphinx/description.txt	Sat Oct 01 09:32:27 2022 +0000
     1.3 @@ -0,0 +1,26 @@
     1.4 +Sphinx is a tool that makes it easy to create intelligent and beautiful
     1.5 +documentation for Python projects (or other documents consisting of multiple
     1.6 +reStructuredText sources), written by Georg Brandl.
     1.7 +It was originally created for the new Python documentation, and has excellent
     1.8 +facilities for Python project documentation, but C/C++ is supported as well,
     1.9 +and more languages are planned.
    1.10 +
    1.11 +Sphinx uses reStructuredText as its markup language, and many of its strengths
    1.12 +come from the power and straightforwardness of reStructuredText and its parsing
    1.13 +and translating suite, the Docutils.
    1.14 +
    1.15 +Among its features are the following:
    1.16 +
    1.17 +- Output formats: HTML (including derivative formats such as HTML Help, Epub
    1.18 +  and Qt Help), plain text, manual pages and LaTeX or direct PDF output using
    1.19 +  rst2pdf
    1.20 +- Extensive cross-references: semantic markup and automatic links for functions,
    1.21 +  classes, glossary terms and similar pieces of information
    1.22 +- Hierarchical structure: easy definition of a document tree, with automatic
    1.23 +  links to siblings, parents and children
    1.24 +- Automatic indices: general index as well as a module index
    1.25 +- Code handling: automatic highlighting using the Pygments highlighter
    1.26 +- Flexible HTML output using the Jinja 2 templating engine
    1.27 +- Various extensions are available, e.g. for automatic testing of snippets and
    1.28 +  inclusion of appropriately formatted docstrings
    1.29 +- Setuptools integration