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