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