Ravenports generated: 27 Mar 2022 16:18
[ravenports.git] / bucket_B7 / python-Sphinx
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-Sphinx
4 VERSION=                4.5.0
5 KEYWORDS=               python
6 VARIANTS=               py39 py310
7 SDESC[py310]=           Python documentation generator (3.10)
8 SDESC[py39]=            Python documentation generator (3.9)
9 HOMEPAGE=               https://www.sphinx-doc.org/
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/91/96/9cbbc7103fb482d5809fe4976ecb9b627058210d02817fcbfeebeaa8f762
14 DISTFILE[1]=            Sphinx-4.5.0-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[py310]=           single
17 SPKGS[py39]=            single
18
19 OPTIONS_AVAILABLE=      PY39 PY310
20 OPTIONS_STANDARD=       none
21 VOPTS[py310]=           PY39=OFF PY310=ON
22 VOPTS[py39]=            PY39=ON PY310=OFF
23
24 DISTNAME=               Sphinx-4.5.0.dist-info
25
26 GENERATED=              yes
27
28 [PY39].RUN_DEPENDS_ON=                  python-sphinxcontrib-applehelp:single:py39
29                                         python-sphinxcontrib-devhelp:single:py39
30                                         python-sphinxcontrib-jsmath:single:py39
31                                         python-sphinxcontrib-htmlhelp:single:py39
32                                         python-sphinxcontrib-serializinghtml:single:py39
33                                         python-sphinxcontrib-qthelp:single:py39
34                                         python-Jinja2:single:py39
35                                         python-Pygments:single:py39
36                                         python-docutils:single:py39
37                                         python-snowballstemmer:single:py39
38                                         python-Babel:single:py39
39                                         python-alabaster:single:py39
40                                         python-imagesize:single:py39
41                                         python-requests:single:py39
42                                         python-packaging:single:py39
43                                         python-importlib-metadata:single:py39
44                                         python-colorama:single:py39
45 [PY39].USES_ON=                         python:py39,wheel
46
47 [PY310].RUN_DEPENDS_ON=                 python-sphinxcontrib-applehelp:single:py310
48                                         python-sphinxcontrib-devhelp:single:py310
49                                         python-sphinxcontrib-jsmath:single:py310
50                                         python-sphinxcontrib-htmlhelp:single:py310
51                                         python-sphinxcontrib-serializinghtml:single:py310
52                                         python-sphinxcontrib-qthelp:single:py310
53                                         python-Jinja2:single:py310
54                                         python-Pygments:single:py310
55                                         python-docutils:single:py310
56                                         python-snowballstemmer:single:py310
57                                         python-Babel:single:py310
58                                         python-alabaster:single:py310
59                                         python-imagesize:single:py310
60                                         python-requests:single:py310
61                                         python-packaging:single:py310
62                                         python-colorama:single:py310
63 [PY310].USES_ON=                        python:py310,wheel
64
65 [FILE:2845:descriptions/desc.single]
66 ========
67  Sphinx
68 ========
69
70    :alt: Package on PyPI
71
72    :alt: Documentation Status
73
74    :alt: Build Status (AppVeyor)
75
76    :alt: Build Status (CircleCI)
77
78    :alt: Code Coverage Status (Codecov)
79
80    :alt: BSD 3 Clause
81
82    :alt: Open Source Helpers badge
83
84 Sphinx is a tool that makes it easy to create intelligent and beautiful
85 documentation for Python projects (or other documents consisting of
86 multiple
87 reStructuredText sources), written by Georg Brandl.  It was originally
88 created
89 for the new Python documentation, and has excellent facilities for Python
90 project documentation, but C/C++ is supported as well, and more languages
91 are
92 planned.
93
94 Sphinx uses reStructuredText as its markup language, and many of its
95 strengths
96 come from the power and straightforwardness of reStructuredText and its
97 parsing
98 and translating suite, the Docutils.
99
100 Among its features are the following:
101
102 * Output formats: HTML (including derivative formats such as HTML Help,
103 Epub
104   and Qt Help), plain text, manual pages and LaTeX or direct PDF output
105   using rst2pdf
106 * Extensive cross-references: semantic markup and automatic links
107   for functions, classes, glossary terms and similar pieces of information
108 * Hierarchical structure: easy definition of a document tree, with
109 automatic
110   links to siblings, parents and children
111 * Automatic indices: general index as well as a module index
112 * Code handling: automatic highlighting using the Pygments highlighter
113 * Flexible HTML output using the Jinja 2 templating engine
114 * Various extensions are available, e.g. for automatic testing of snippets
115   and inclusion of appropriately formatted docstrings
116 * Setuptools integration
117
118 For more information, refer to the `the documentation`__.
119
120 .. __: http://www.sphinx-doc.org/
121
122 Installation
123 ============
124
125 Sphinx is published on `PyPI`__ and can be installed from there::
126
127    pip install -U sphinx
128
129 We also publish beta releases::
130
131    pip install -U --pre sphinx
132
133 If you wish to install `Sphinx` for development purposes, refer to `the
134 contributors guide`__.
135
136 __ https://pypi.org/project/Sphinx/
137 __ http://www.sphinx-doc.org/en/master/internals/contributing.html
138
139 Documentation
140 =============
141
142 Documentation is available from `sphinx-doc.org`__.
143
144 __ http://www.sphinx-doc.org/
145
146 Get in touch
147 ============
148
149 - Report bugs, suggest features or view the source code `on GitHub`_.
150 - For less well defined questions or ideas, use the `mailing list`_.
151
152 .. _on GitHub: https://github.com/sphinx-doc/sphinx
153 .. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
154
155 Please adhere to our `code of conduct`__.
156
157 __ http://www.sphinx-doc.org/en/master/code_of_conduct.html
158
159 Testing
160 =======
161
162 Continuous testing is provided by `Travis`__ (for unit tests and style
163 checks
164 on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for
165 large processes like TeX compilation).
166
167
168 [FILE:108:distinfo]
169 ebf612653238bcc8f4359627a9b7ce44ede6fdd75d9d30f68255c7383d3a6226      3099508 Sphinx-4.5.0-py3-none-any.whl
170