bucket_B7/python-Sphinx

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