bucket_B7/python-Sphinx

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-Sphinx
   4 VERSION=                3.2.0
   5 KEYWORDS=               python
   6 VARIANTS=               py38 py37
   7 SDESC[py37]=            Python documentation generator (PY37)
   8 SDESC[py38]=            Python documentation generator (PY38)
   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.2.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:primary:standard
  25
  26 DISTNAME=               Sphinx-3.2.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:2766:descriptions/desc.single]
  69 ========
  70  Sphinx
  71 ========
  72
  73    :alt: Package on PyPI
  74
  75    :alt: Documentation Status
  76
  77    :alt: Build Status (Travis CI)
  78
  79    :alt: Build Status (AppVeyor)
  80
  81    :alt: Build Status (CircleCI)
  82
  83    :alt: Code Coverage Status (Codecov)
  84
  85    :alt: BSD 3 Clause
  86
  87    :alt: Open Source Helpers badge
  88
  89 Sphinx is a tool that makes it easy to create intelligent and beautiful
  90 documentation for Python projects (or other documents consisting of
  91 multiple
  92 reStructuredText sources), written by Georg Brandl.  It was originally
  93 created
  94 for the new Python documentation, and has excellent facilities for Python
  95 project documentation, but C/C++ is supported as well, and more languages
  96 are
  97 planned.
  98
  99 Sphinx uses reStructuredText as its markup language, and many of its
 100 strengths
 101 come from the power and straightforwardness of reStructuredText and its
 102 parsing
 103 and translating suite, the Docutils.
 104
 105 Among its features are the following:
 106
 107 * Output formats: HTML (including derivative formats such as HTML Help,
 108 Epub
 109   and Qt Help), plain text, manual pages and LaTeX or direct PDF output
 110   using rst2pdf
 111 * Extensive cross-references: semantic markup and automatic links
 112   for functions, classes, glossary terms and similar pieces of information
 113 * Hierarchical structure: easy definition of a document tree, with
 114 automatic
 115   links to siblings, parents and children
 116 * Automatic indices: general index as well as a module index
 117 * Code handling: automatic highlighting using the Pygments highlighter
 118 * Flexible HTML output using the Jinja 2 templating engine
 119 * Various extensions are available, e.g. for automatic testing of snippets
 120   and inclusion of appropriately formatted docstrings
 121 * Setuptools integration
 122
 123 For more information, refer to the `the documentation`__.
 124
 125 .. __: http://www.sphinx-doc.org/
 126
 127 Installation
 128 ============
 129
 130 Sphinx is published on `PyPI`__ and can be installed from there::
 131
 132    pip install -U sphinx
 133
 134 We also publish beta releases::
 135
 136    pip install -U --pre sphinx
 137
 138 If you wish to install `Sphinx` for development purposes, refer to `the
 139 contributors guide`__.
 140
 141 __ https://pypi.org/project/Sphinx/
 142 __ http://www.sphinx-doc.org/en/master/internals/contributing.html
 143
 144 Documentation
 145 =============
 146
 147 Documentation is available from `sphinx-doc.org`__.
 148
 149 __ http://www.sphinx-doc.org/
 150
 151 Get in touch
 152 ============
 153
 154 - Report bugs, suggest features or view the source code `on GitHub`_.
 155 - For less well defined questions or ideas, use the `mailing list`_.
 156
 157 .. _on GitHub: https://github.com/sphinx-doc/sphinx
 158 .. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users
 159
 160 Please adhere to our `code of conduct`__.
 161
 162 __ http://www.sphinx-doc.org/en/master/code_of_conduct.html
 163
 164 Testing
 165 =======
 166
 167 Continuous testing is provided by `Travis`__ (for unit tests and style
 168 checks
 169
 170
 171 [FILE:98:distinfo]
 172 cf2d5bc3c6c930ab0a1fbef3ad8a82994b1bf4ae923f8098a05c7e5516f07177      5970521 Sphinx-3.2.0.tar.gz
 173