mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update long_description a bit.
This commit is contained in:
parent
8bb4d4320d
commit
59a7070e7e
11
setup.py
11
setup.py
@ -21,19 +21,20 @@ Sphinx uses reStructuredText as its markup language, and many of its strengths
|
|||||||
come from the power and straightforwardness of reStructuredText and its
|
come from the power and straightforwardness of reStructuredText and its
|
||||||
parsing and translating suite, the Docutils.
|
parsing and translating suite, the Docutils.
|
||||||
|
|
||||||
Although it is still under constant development, the following features
|
Among its features are the following:
|
||||||
are already present, work fine and can be seen "in action" in the Python docs:
|
|
||||||
|
|
||||||
* Output formats: HTML (including Windows HTML Help), plain text and LaTeX,
|
* Output formats: HTML (including derivative formats such as HTML Help, Epub
|
||||||
for printable PDF versions
|
and Qt Help), plain text and LaTeX or direct PDF output using rst2pdf
|
||||||
* Extensive cross-references: semantic markup and automatic links
|
* Extensive cross-references: semantic markup and automatic links
|
||||||
for functions, classes, glossary terms and similar pieces of information
|
for functions, classes, glossary terms and similar pieces of information
|
||||||
* Hierarchical structure: easy definition of a document tree, with automatic
|
* Hierarchical structure: easy definition of a document tree, with automatic
|
||||||
links to siblings, parents and children
|
links to siblings, parents and children
|
||||||
* Automatic indices: general index as well as a module index
|
* Automatic indices: general index as well as a module index
|
||||||
* Code handling: automatic highlighting using the Pygments highlighter
|
* 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
|
* Various extensions are available, e.g. for automatic testing of snippets
|
||||||
and inclusion of appropriately formatted docstrings.
|
and inclusion of appropriately formatted docstrings
|
||||||
|
* Setuptools integration
|
||||||
|
|
||||||
A development egg can be found `here
|
A development egg can be found `here
|
||||||
<http://bitbucket.org/birkenfeld/sphinx/get/tip.gz#egg=Sphinx-dev>`_.
|
<http://bitbucket.org/birkenfeld/sphinx/get/tip.gz#egg=Sphinx-dev>`_.
|
||||||
|
Loading…
Reference in New Issue
Block a user