1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
Metadata-Version: 2.1
Name: Sphinx
Version: 7.4.7
Summary: Python documentation generator
Author-email: Georg Brandl <georg@python.org>
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Domain
Classifier: Framework :: Sphinx :: Extension
Classifier: Framework :: Sphinx :: Theme
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Printing
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: General
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Classifier: Topic :: Utilities
Requires-Dist: sphinxcontrib-applehelp
Requires-Dist: sphinxcontrib-devhelp
Requires-Dist: sphinxcontrib-jsmath
Requires-Dist: sphinxcontrib-htmlhelp>=2.0.0
Requires-Dist: sphinxcontrib-serializinghtml>=1.1.9
Requires-Dist: sphinxcontrib-qthelp
Requires-Dist: Jinja2>=3.1
Requires-Dist: Pygments>=2.17
Requires-Dist: docutils>=0.20,<0.22
Requires-Dist: snowballstemmer>=2.2
Requires-Dist: babel>=2.13
Requires-Dist: alabaster~=0.7.14
Requires-Dist: imagesize>=1.3
Requires-Dist: requests>=2.30.0
Requires-Dist: packaging>=23.0
Requires-Dist: importlib-metadata>=6.0; python_version < '3.10'
Requires-Dist: tomli>=2; python_version < '3.11'
Requires-Dist: colorama>=0.4.6; sys_platform == 'win32'
Requires-Dist: sphinxcontrib-websupport ; extra == "docs"
Requires-Dist: flake8>=6.0 ; extra == "lint"
Requires-Dist: ruff==0.5.2 ; extra == "lint"
Requires-Dist: mypy==1.10.1 ; extra == "lint"
Requires-Dist: sphinx-lint>=0.9 ; extra == "lint"
Requires-Dist: types-docutils==0.21.0.20240711 ; extra == "lint"
Requires-Dist: types-requests>=2.30.0 ; extra == "lint"
Requires-Dist: importlib-metadata>=6.0 ; extra == "lint"
Requires-Dist: tomli>=2 ; extra == "lint"
Requires-Dist: pytest>=6.0 ; extra == "lint"
Requires-Dist: pytest>=8.0 ; extra == "test"
Requires-Dist: defusedxml>=0.7.1 ; extra == "test"
Requires-Dist: cython>=3.0 ; extra == "test"
Requires-Dist: setuptools>=70.0 ; extra == "test"
Requires-Dist: typing_extensions>=4.9 ; extra == "test"
Project-URL: Changelog, https://www.sphinx-doc.org/en/master/changes.html
Project-URL: Code, https://github.com/sphinx-doc/sphinx
Project-URL: Download, https://pypi.org/project/Sphinx/
Project-URL: Homepage, https://www.sphinx-doc.org/
Project-URL: Issue tracker, https://github.com/sphinx-doc/sphinx/issues
Provides-Extra: docs
Provides-Extra: lint
Provides-Extra: test
========
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 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/
|
