The Sphinx documentation generator
Go to file
Adam Turner 4a3febb69a
Add an option for displaying short `Literal` types (#11109)
The new ``python_display_short_literal_types`` configuration option
for the ``py`` domain controls display of PEP 586 ``Literal`` types.
The 'short' format is inspired by PEP 604, using the bitwise OR operator
to distinguish the possible legal values for the argument.
2023-04-05 13:07:25 +01:00
.github Run Ruff linting with a known-to-work version 2023-03-31 17:52:29 +01:00
doc Add an option for displaying short `Literal` types (#11109) 2023-04-05 13:07:25 +01:00
sphinx Add an option for displaying short `Literal` types (#11109) 2023-04-05 13:07:25 +01:00
tests Add an option for displaying short `Literal` types (#11109) 2023-04-05 13:07:25 +01:00
utils Update translations workflow for new `tx` client 2023-03-15 15:45:36 +00:00
.codecov.yml Revert "Enable patch status check for Codecov" 2020-03-15 11:09:06 +09:00
.flake8 Ignore SIM910 for time being to appease flake8-simplify 0.20.0 2023-03-31 17:36:47 +02:00
.git-blame-ignore-revs Add entries to the `.git-blame-ignore-revs` file 2023-04-04 22:06:49 +01:00
.gitignore C++, add support for parameterized noexcept specifier in function declarations 2020-04-24 23:59:41 +02:00
.readthedocs.yml RTD builder: add graphviz depedendency (#11040) 2022-12-20 12:30:59 +00:00
AUTHORS Properly support of in docstring type specifiers (#10738) 2022-08-02 23:43:32 +01:00
bindep.txt Update bindep.txt for LaTeX pict2e.sty optional dependency 2022-07-18 19:26:08 +02:00
CHANGES Add an option for displaying short `Literal` types (#11109) 2023-04-05 13:07:25 +01:00
CODE_OF_CONDUCT docs: Tweaks to code of conduct 2020-06-02 12:10:24 +01:00
CONTRIBUTING.rst Minor typo in the contributing info 2020-12-16 12:09:17 -05:00
EXAMPLES Create a `pydata_sphinx_theme` section in usage examples (#11046) 2022-12-29 13:59:34 +00:00
karma.conf.js Split out sphinx_highlight.js 2022-09-24 15:10:57 +01:00
LICENSE Remove `smartypants` from LICENSE (#11152) 2023-02-15 04:47:30 +00:00
Makefile Use declarative metadata 2022-09-13 10:31:27 +01:00
package-lock.json Merge branch '4.x' into 5.x 2022-04-03 00:33:25 +09:00
package.json Merge branch '4.x' 2022-03-19 22:58:15 +09:00
pyproject.toml Resolve lint errors from Ruff 0.0.260 2023-03-31 17:52:51 +01:00
README.rst Add GPG key for Adam Turner 2022-07-17 23:03:38 +01:00
tox.ini Treat Python warnings as errors during testing 2023-02-15 04:34:10 +00:00

========
 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.

Release signatures
==================

Releases are signed with following keys:

* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_
* `61F0FB52 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x52C8F72A61F0FB52>`_

.. _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/