bucket_B7/python-Sphinx

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