bucket_B7/python-Sphinx

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