mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Reformat the introduction and features list
This commit is contained in:
parent
54acdc613c
commit
a74755dbc7
31
README.rst
31
README.rst
@ -22,32 +22,27 @@
|
|||||||
:target: https://pypistats.org/packages/sphinx
|
:target: https://pypistats.org/packages/sphinx
|
||||||
:alt: Monthly PyPI installs
|
:alt: Monthly PyPI installs
|
||||||
|
|
||||||
Sphinx is a tool that makes it easy to create intelligent and beautiful
|
**Sphinx makes it easy to create intelligent and beautiful documentation.**
|
||||||
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
|
Sphinx uses reStructuredText as its markup language, and many of its strengths
|
||||||
come from the power and straightforwardness of reStructuredText and its parsing
|
come from the power and straightforwardness of reStructuredText and its parsing
|
||||||
and translating suite, the Docutils.
|
and translating suite, the Docutils.
|
||||||
|
|
||||||
Among its features are the following:
|
Features
|
||||||
|
========
|
||||||
|
|
||||||
* Output formats: HTML (including derivative formats such as HTML Help, Epub
|
* **Output formats**: HTML, PDF, plain text, EPub, TeX, manual pages, and more
|
||||||
and Qt Help), plain text, manual pages and LaTeX or direct PDF output
|
* **Extensive cross-references**: semantic markup and automatic links
|
||||||
using rst2pdf
|
|
||||||
* 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 highlighting**: automatic highlighting using the Pygments highlighter
|
||||||
* Flexible HTML output using the Jinja 2 templating engine
|
* **Templating**: Flexible HTML output using the Jinja 2 templating engine
|
||||||
* Various extensions are available, e.g. for automatic testing of snippets
|
* **Extension ecosystem**: Many extensions are available, for example for
|
||||||
and inclusion of appropriately formatted docstrings
|
automatic function documentation or working with Jupyter notebooks.
|
||||||
* Setuptools integration
|
* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other
|
||||||
|
languages through extensions.
|
||||||
|
|
||||||
For more information, refer to the `the documentation`_.
|
For more information, refer to the `the documentation`_.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user