1Metadata-Version: 2.1
2Name: Sphinx
3Version: 3.5.2
4Summary: Python documentation generator
5Home-page: http://sphinx-doc.org/
6Author: Georg Brandl
7Author-email: georg@python.org
8License: BSD
9Download-URL: https://pypi.org/project/Sphinx/
10Project-URL: Code, https://github.com/sphinx-doc/sphinx
11Project-URL: Issue tracker, https://github.com/sphinx-doc/sphinx/issues
12Platform: any
13Classifier: Development Status :: 5 - Production/Stable
14Classifier: Environment :: Console
15Classifier: Environment :: Web Environment
16Classifier: Intended Audience :: Developers
17Classifier: Intended Audience :: Education
18Classifier: Intended Audience :: End Users/Desktop
19Classifier: Intended Audience :: Science/Research
20Classifier: Intended Audience :: System Administrators
21Classifier: License :: OSI Approved :: BSD License
22Classifier: Operating System :: OS Independent
23Classifier: Programming Language :: Python
24Classifier: Programming Language :: Python :: 3
25Classifier: Programming Language :: Python :: 3 :: Only
26Classifier: Programming Language :: Python :: 3.5
27Classifier: Programming Language :: Python :: 3.6
28Classifier: Programming Language :: Python :: 3.7
29Classifier: Programming Language :: Python :: 3.8
30Classifier: Programming Language :: Python :: 3.9
31Classifier: Programming Language :: Python :: Implementation :: CPython
32Classifier: Programming Language :: Python :: Implementation :: PyPy
33Classifier: Framework :: Setuptools Plugin
34Classifier: Framework :: Sphinx
35Classifier: Framework :: Sphinx :: Extension
36Classifier: Framework :: Sphinx :: Theme
37Classifier: Topic :: Documentation
38Classifier: Topic :: Documentation :: Sphinx
39Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
40Classifier: Topic :: Printing
41Classifier: Topic :: Software Development
42Classifier: Topic :: Software Development :: Documentation
43Classifier: Topic :: Text Processing
44Classifier: Topic :: Text Processing :: General
45Classifier: Topic :: Text Processing :: Indexing
46Classifier: Topic :: Text Processing :: Markup
47Classifier: Topic :: Text Processing :: Markup :: HTML
48Classifier: Topic :: Text Processing :: Markup :: LaTeX
49Classifier: Topic :: Utilities
50Requires-Python: >=3.5
51Description-Content-Type: text/x-rst
52Provides-Extra: docs
53Provides-Extra: lint
54Provides-Extra: test
55License-File: LICENSE
56
57========
58 Sphinx
59========
60
61.. image:: https://img.shields.io/pypi/v/sphinx.svg
62   :target: https://pypi.org/project/Sphinx/
63   :alt: Package on PyPI
64
65.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
66   :target: http://www.sphinx-doc.org/
67   :alt: Documentation Status
68
69.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
70   :target: https://travis-ci.org/sphinx-doc/sphinx
71   :alt: Build Status (Travis CI)
72
73.. image:: https://ci.appveyor.com/api/projects/status/github/sphinx-doc/sphinx?branch=master&svg=true
74   :target: https://ci.appveyor.com/project/sphinxdoc/sphinx
75   :alt: Build Status (AppVeyor)
76
77.. image:: https://circleci.com/gh/sphinx-doc/sphinx.svg?style=shield
78   :target: https://circleci.com/gh/sphinx-doc/sphinx
79   :alt: Build Status (CircleCI)
80
81.. image:: https://codecov.io/gh/sphinx-doc/sphinx/branch/master/graph/badge.svg
82   :target: https://codecov.io/gh/sphinx-doc/sphinx
83   :alt: Code Coverage Status (Codecov)
84
85.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
86   :target: https://opensource.org/licenses/BSD-3-Clause
87   :alt: BSD 3 Clause
88
89.. image:: https://codetriage.com/sphinx-doc/sphinx/badges/users.svg
90   :target: https://codetriage.com/sphinx-doc/sphinx
91   :alt: Open Source Helpers badge
92
93Sphinx is a tool that makes it easy to create intelligent and beautiful
94documentation for Python projects (or other documents consisting of multiple
95reStructuredText sources), written by Georg Brandl.  It was originally created
96for the new Python documentation, and has excellent facilities for Python
97project documentation, but C/C++ is supported as well, and more languages are
98planned.
99
100Sphinx uses reStructuredText as its markup language, and many of its strengths
101come from the power and straightforwardness of reStructuredText and its parsing
102and translating suite, the Docutils.
103
104Among its features are the following:
105
106* Output formats: HTML (including derivative formats such as HTML Help, Epub
107  and Qt Help), plain text, manual pages and LaTeX or direct PDF output
108  using rst2pdf
109* Extensive cross-references: semantic markup and automatic links
110  for functions, classes, glossary terms and similar pieces of information
111* Hierarchical structure: easy definition of a document tree, with automatic
112  links to siblings, parents and children
113* Automatic indices: general index as well as a module index
114* Code handling: automatic highlighting using the Pygments highlighter
115* Flexible HTML output using the Jinja 2 templating engine
116* Various extensions are available, e.g. for automatic testing of snippets
117  and inclusion of appropriately formatted docstrings
118* Setuptools integration
119
120For more information, refer to the `the documentation`__.
121
122.. __: http://www.sphinx-doc.org/
123
124Installation
125============
126
127Sphinx is published on `PyPI`__ and can be installed from there::
128
129   pip install -U sphinx
130
131We also publish beta releases::
132
133   pip install -U --pre sphinx
134
135If you wish to install `Sphinx` for development purposes, refer to `the
136contributors guide`__.
137
138__ https://pypi.org/project/Sphinx/
139__ http://www.sphinx-doc.org/en/master/internals/contributing.html
140
141Documentation
142=============
143
144Documentation is available from `sphinx-doc.org`__.
145
146__ http://www.sphinx-doc.org/
147
148Get in touch
149============
150
151- Report bugs, suggest features or view the source code `on GitHub`_.
152- For less well defined questions or ideas, use the `mailing list`_.
153
154.. _on GitHub: https://github.com/sphinx-doc/sphinx
155.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
156
157Please adhere to our `code of conduct`__.
158
159__ http://www.sphinx-doc.org/en/master/code_of_conduct.html
160
161Testing
162=======
163
164Continuous testing is provided by `Travis`__ (for unit tests and style checks
165on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for
166large processes like TeX compilation).
167
168For information on running tests locally, refer to `the contributors guide`__.
169
170__ https://travis-ci.org/sphinx-doc/sphinx
171__ https://ci.appveyor.com/project/sphinxdoc/sphinx
172__ https://circleci.com/gh/sphinx-doc/sphinx
173__ http://www.sphinx-doc.org/en/master/internals/contributing.html
174
175Contributing
176============
177
178Refer to `the contributors guide`__.
179
180__ http://www.sphinx-doc.org/en/master/internals/contributing.html
181
182Release signatures
183==================
184
185Releases are signed with following keys:
186
187* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
188* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_
189
190
191