bucket_B7/python-Sphinx

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