bucket_B7/python-Sphinx

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-Sphinx
   4 VERSION=                2.3.0
   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-2.3.0.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:single:standard
  25
  26 DISTNAME=               Sphinx-2.3.0
  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:3535: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 Sphinx is a tool that makes it easy to create intelligent and beautiful
 101 documentation for Python projects (or other documents consisting of
 102 multiple
 103 reStructuredText sources), written by Georg Brandl.  It was originally
 104 created
 105 for the new Python documentation, and has excellent facilities for Python
 106 project documentation, but C/C++ is supported as well, and more languages
 107 are
 108 planned.
 109
 110 Sphinx uses reStructuredText as its markup language, and many of its
 111 strengths
 112 come from the power and straightforwardness of reStructuredText and its
 113 parsing
 114 and translating suite, the Docutils.
 115
 116 Among its features are the following:
 117
 118 * Output formats: HTML (including derivative formats such as HTML Help,
 119 Epub
 120   and Qt Help), plain text, manual pages and LaTeX or direct PDF output
 121   using rst2pdf
 122 * Extensive cross-references: semantic markup and automatic links
 123   for functions, classes, glossary terms and similar pieces of information
 124 * Hierarchical structure: easy definition of a document tree, with
 125 automatic
 126   links to siblings, parents and children
 127 * Automatic indices: general index as well as a module index
 128 * Code handling: automatic highlighting using the Pygments highlighter
 129 * Flexible HTML output using the Jinja 2 templating engine
 130 * Various extensions are available, e.g. for automatic testing of snippets
 131   and inclusion of appropriately formatted docstrings
 132 * Setuptools integration
 133
 134 For more information, refer to the `the documentation`__.
 135
 136 .. __: http://www.sphinx-doc.org/
 137
 138 Installation
 139 ============
 140
 141 Sphinx is published on `PyPI`__ and can be installed from there::
 142
 143    pip install -U sphinx
 144
 145 We also publish beta releases::
 146
 147    pip install -U --pre sphinx
 148
 149 If you wish to install `Sphinx` for development purposes, refer to `the
 150 contributors guide`__.
 151
 152 __ https://pypi.org/project/Sphinx/
 153 __ http://www.sphinx-doc.org/en/master/devguide.html
 154
 155 Documentation
 156 =============
 157
 158 Documentation is available from `sphinx-doc.org`__.
 159
 160 __ http://www.sphinx-doc.org/
 161
 162 Get in touch
 163 ============
 164
 165 - Report bugs, suggest features or view the source code `on GitHub`_.
 166 - For less well defined questions or ideas, use the `mailing list`_.
 167
 168 .. _on GitHub: https://github.com/sphinx-doc/sphinx
 169 .. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
 170
 171 Testing
 172 =======
 173
 174 Continuous testing is provided by `Travis`__ (for unit tests and style
 175 checks
 176 on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for
 177 large processes like TeX compilation).
 178
 179 For information on running tests locally, refer to `the contributors
 180 guide`__.
 181
 182
 183 [FILE:98:distinfo]
 184 0a11e2fd31fe5c7e64b4fc53c2c022946512f021d603eb41ac6ae51d5fcbb574      5838606 Sphinx-2.3.0.tar.gz
 185