Ravenports generated: 17 Feb 2018 13:46
[ravenports.git] / bucket_B7 / python-Sphinx
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-Sphinx
4 VERSION=                1.7.0
5 KEYWORDS=               python devel textproc
6 VARIANTS=               py27 py35 py36
7 SDESC[py35]=            Python documentation generator (PY 35)
8 SDESC[py36]=            Python documentation generator (PY 36)
9 SDESC[py27]=            Python documentation generator (PY 27)
10 HOMEPAGE=               http://sphinx-doc.org/
11 CONTACT=                Python_Automaton[python@ironwolf.systems]
12
13 DOWNLOAD_GROUPS=        main
14 SITES[main]=            PYPI/S/Sphinx
15 DISTFILE[1]=            Sphinx-1.7.0.tar.gz:main
16 DF_INDEX=               1
17 SPKGS[py35]=            single
18 SPKGS[py36]=            single
19 SPKGS[py27]=            single
20
21 OPTIONS_AVAILABLE=      PY27 PY35 PY36
22 OPTIONS_STANDARD=       none
23 VOPTS[py35]=            PY27=OFF PY35=ON PY36=OFF
24 VOPTS[py36]=            PY27=OFF PY35=OFF PY36=ON
25 VOPTS[py27]=            PY27=ON PY35=OFF PY36=OFF
26
27 DISTNAME=               Sphinx-1.7.0
28
29 LICENSE=                BSD2CLAUSE:single
30 LICENSE_SCHEME=         solo
31 LICENSE_FILE=           BSD2CLAUSE:{{WRKSRC}}/LICENSE
32
33 GENERATED=              yes
34
35 [PY35].BUILDRUN_DEPENDS_ON=             python-six:single:py35
36                                         python-Jinja2:single:py35
37                                         python-Pygments:single:py35
38                                         python-docutils:single:py35
39                                         python-snowballstemmer:single:py35
40                                         python-Babel:single:py35
41                                         python-alabaster:single:py35
42                                         python-imagesize:single:py35
43                                         python-requests:single:py35
44                                         python-setuptools:single:py35
45                                         python-packaging:single:py35
46                                         python-sphinxcontrib-websupport:single:py35
47 [PY35].USES_ON=                         python:py35
48
49 [PY36].BUILDRUN_DEPENDS_ON=             python-six:single:py36
50                                         python-Jinja2:single:py36
51                                         python-Pygments:single:py36
52                                         python-docutils:single:py36
53                                         python-snowballstemmer:single:py36
54                                         python-Babel:single:py36
55                                         python-alabaster:single:py36
56                                         python-imagesize:single:py36
57                                         python-requests:single:py36
58                                         python-setuptools:single:py36
59                                         python-packaging:single:py36
60                                         python-sphinxcontrib-websupport:single:py36
61 [PY36].USES_ON=                         python:py36
62
63 [PY27].BUILDRUN_DEPENDS_ON=             python-six:single:py27
64                                         python-Jinja2:single:py27
65                                         python-Pygments:single:py27
66                                         python-docutils:single:py27
67                                         python-snowballstemmer:single:py27
68                                         python-Babel:single:py27
69                                         python-alabaster:single:py27
70                                         python-imagesize:single:py27
71                                         python-requests:single:py27
72                                         python-setuptools:single:py27
73                                         python-packaging:single:py27
74                                         python-sphinxcontrib-websupport:single:py27
75 [PY27].RUN_DEPENDS_ON=                  python-typing:single:py27
76 [PY27].USES_ON=                         python:py27
77
78 [FILE:3391:descriptions/desc.single]
79 ========
80  Sphinx
81 ========
82
83 .. image:: https://img.shields.io/pypi/v/sphinx.svg
84    :target: https://pypi.python.org/pypi/Sphinx
85    :alt: Package on PyPi
86
87 .. image:: https://readthedocs.org/projects/sphinx/badge/
88    :target: http://www.sphinx-doc.org/
89    :alt: Documentation Status
90
91 .. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
92    :target: https://travis-ci.org/sphinx-doc/sphinx
93    :alt: Build Status (Travis CI)
94
95 .. image::
96 https://ci.appveyor.com/api/projects/status/github/sphinx-doc/sphinx?branch
97 =master&svg=true
98    :target: https://ci.appveyor.com/project/sphinxdoc/sphinx
99    :alt: Build Status (AppVeyor)
100
101 .. image:: https://circleci.com/gh/sphinx-doc/sphinx.svg?style=shield
102    :target: https://circleci.com/gh/sphinx-doc/sphinx
103    :alt: Build Status (CircleCI)
104
105 .. image::
106 https://codecov.io/gh/sphinx-doc/sphinx/branch/master/graph/badge.svg
107    :target: https://codecov.io/gh/sphinx-doc/sphinx
108    :alt: Code Coverage Status (Codecov)
109
110 Sphinx is a tool that makes it easy to create intelligent and beautiful
111 documentation for Python projects (or other documents consisting of
112 multiple
113 reStructuredText sources), written by Georg Brandl.  It was originally
114 created
115 for the new Python documentation, and has excellent facilities for Python
116 project documentation, but C/C++ is supported as well, and more languages
117 are
118 planned.
119
120 Sphinx uses reStructuredText as its markup language, and many of its
121 strengths
122 come from the power and straightforwardness of reStructuredText and its
123 parsing
124 and translating suite, the Docutils.
125
126 Among its features are the following:
127
128 * Output formats: HTML (including derivative formats such as HTML Help,
129 Epub
130   and Qt Help), plain text, manual pages and LaTeX or direct PDF output
131   using rst2pdf
132 * Extensive cross-references: semantic markup and automatic links
133   for functions, classes, glossary terms and similar pieces of information
134 * Hierarchical structure: easy definition of a document tree, with
135 automatic
136   links to siblings, parents and children
137 * Automatic indices: general index as well as a module index
138 * Code handling: automatic highlighting using the Pygments highlighter
139 * Flexible HTML output using the Jinja 2 templating engine
140 * Various extensions are available, e.g. for automatic testing of snippets
141   and inclusion of appropriately formatted docstrings
142 * Setuptools integration
143
144 For more information, refer to the `the documentation`__.
145
146 .. __: http://www.sphinx-doc.org/
147
148 Installation
149 ============
150
151 Sphinx is published on `PyPI`__ and can be installed from there::
152
153    pip install -U sphinx
154
155 We also publish beta releases::
156
157    pip install -U --pre sphinx
158
159 If you wish to install `Sphinx` for development purposes, refer to `the
160 contributors guide`__.
161
162 __ https://pypi.python.org/pypi/Sphinx
163 __ CONTRIBUTING.rst
164
165 Documentation
166 =============
167
168 Documentation is available from `sphinx-doc.org`__.
169
170 __ http://www.sphinx-doc.org/
171
172 Testing
173 =======
174
175 Continuous testing is provided by `Travis`__ (for unit tests and style
176 checks
177 on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for
178 large processes like TeX compilation).
179
180 For information on running tests locally, refer to `the contributors
181 guide`__.
182
183 __ https://travis-ci.org/sphinx-doc/sphinx
184 __ https://ci.appveyor.com/project/sphinxdoc/sphinx
185 __ https://circleci.com/gh/sphinx-doc/sphinx
186 __ CONTRIBUTING.rst
187
188 Contributing
189 ============
190
191
192
193 [FILE:98:distinfo]
194 278b7923f3f4ed2a1d1359f0ae94d89ac90ddd4189e8362f4b4d3baa2afe6b4a      4712939 Sphinx-1.7.0.tar.gz
195