diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d1ad3f4 --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +======== + Sphinx +======== + +.. image:: https://img.shields.io/pypi/v/sphinx.svg + :target: https://pypi.org/project/Sphinx/ + :alt: Package on PyPI + +.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg + :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml + :alt: Build Status + +.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master + :target: https://www.sphinx-doc.org/ + :alt: Documentation Status + +.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg + :target: https://opensource.org/licenses/BSD-2-Clause + :alt: BSD 2 Clause + +**Sphinx makes it easy to create intelligent and beautiful documentation.** + +Sphinx uses reStructuredText as its markup language, and many of its strengths +come from the power and straightforwardness of reStructuredText and its parsing +and translating suite, the Docutils. + +Features +======== + +* **Output formats**: HTML, PDF, plain text, EPUB, TeX, manual pages, and more +* **Extensive cross-references**: semantic markup and automatic links + for functions, classes, glossary terms and similar pieces of information +* **Hierarchical structure**: easy definition of a document tree, with automatic + links to siblings, parents and children +* **Automatic indices**: general index as well as a module index +* **Code highlighting**: automatic highlighting using the Pygments highlighter +* **Templating**: Flexible HTML output using the Jinja 2 templating engine +* **Extension ecosystem**: Many extensions are available, for example for + automatic function documentation or working with Jupyter notebooks. +* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other + languages through extensions. + +For more information, refer to the `the documentation`_. + +Installation +============ + +The following command installs Sphinx from the `Python Package Index`_. You will +need a working installation of Python and pip. + +.. code-block:: sh + + pip install -U sphinx + +Contributing +============ + +We appreciate all contributions! Refer to `the contributors guide`_ for +information. + +.. _the documentation: https://www.sphinx-doc.org/ +.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html +.. _Python Package Index: https://pypi.org/project/Sphinx/ |