# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-Sphinx
VERSION=		1.8.4
KEYWORDS=		python devel textproc
VARIANTS=		py27 py36 py37
SDESC[py36]=		Python documentation generator (PY 36)
SDESC[py37]=		Python documentation generator (PY 37)
SDESC[py27]=		Python documentation generator (PY 27)
HOMEPAGE=		http://sphinx-doc.org/
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/S/Sphinx
DISTFILE[1]=		Sphinx-1.8.4.tar.gz:main
DF_INDEX=		1
SPKGS[py36]=		single
SPKGS[py37]=		single
SPKGS[py27]=		single

OPTIONS_AVAILABLE=	PY27 PY36 PY37
OPTIONS_STANDARD=	none
VOPTS[py36]=		PY27=OFF PY36=ON PY37=OFF
VOPTS[py37]=		PY27=OFF PY36=OFF PY37=ON
VOPTS[py27]=		PY27=ON PY36=OFF PY37=OFF

DISTNAME=		Sphinx-1.8.4

GENERATED=		yes

[PY36].BUILDRUN_DEPENDS_ON=		python-six:single:py36
					python-Jinja2:single:py36
					python-Pygments:single:py36
					python-docutils:single:py36
					python-snowballstemmer:single:py36
					python-Babel:single:py36
					python-alabaster:single:py36
					python-imagesize:single:py36
					python-requests:single:py36
					python-setuptools:single:py36
					python-packaging:single:py36
					python-sphinxcontrib-websupport:single:py36
[PY36].USES_ON=				python:py36

[PY37].BUILDRUN_DEPENDS_ON=		python-six:single:py37
					python-Jinja2:single:py37
					python-Pygments:single:py37
					python-docutils:single:py37
					python-snowballstemmer:single:py37
					python-Babel:single:py37
					python-alabaster:single:py37
					python-imagesize:single:py37
					python-requests:single:py37
					python-setuptools:single:py37
					python-packaging:single:py37
					python-sphinxcontrib-websupport:single:py37
[PY37].USES_ON=				python:py37

[PY27].BUILDRUN_DEPENDS_ON=		python-six:single:py27
					python-Jinja2:single:py27
					python-Pygments:single:py27
					python-docutils:single:py27
					python-snowballstemmer:single:py27
					python-Babel:single:py27
					python-alabaster:single:py27
					python-imagesize:single:py27
					python-requests:single:py27
					python-setuptools:single:py27
					python-packaging:single:py27
					python-sphinxcontrib-websupport:single:py27
[PY27].RUN_DEPENDS_ON=			python-typing:single:py27
[PY27].USES_ON=				python:py27

[FILE:3535:descriptions/desc.single]
========
 Sphinx
========

.. image:: https://img.shields.io/pypi/v/sphinx.svg
   :target: https://pypi.org/project/Sphinx/
   :alt: Package on PyPI

.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
   :target: http://www.sphinx-doc.org/
   :alt: Documentation Status

.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
   :target: https://travis-ci.org/sphinx-doc/sphinx
   :alt: Build Status (Travis CI)

.. image::
https://ci.appveyor.com/api/projects/status/github/sphinx-doc/sphinx?branch
=master&svg=true
   :target: https://ci.appveyor.com/project/sphinxdoc/sphinx
   :alt: Build Status (AppVeyor)

.. image:: https://circleci.com/gh/sphinx-doc/sphinx.svg?style=shield
   :target: https://circleci.com/gh/sphinx-doc/sphinx
   :alt: Build Status (CircleCI)

.. image::
https://codecov.io/gh/sphinx-doc/sphinx/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/sphinx-doc/sphinx
   :alt: Code Coverage Status (Codecov)

Sphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of
multiple
reStructuredText sources), written by Georg Brandl.  It was originally
created
for the new Python documentation, and has excellent facilities for Python
project documentation, but C/C++ is supported as well, and more languages
are
planned.

Sphinx uses reStructuredText as its markup language, and many of its
strengths
come from the power and straightforwardness of reStructuredText and its
parsing
and translating suite, the Docutils.

Among its features are the following:

* Output formats: HTML (including derivative formats such as HTML Help,
Epub
  and Qt Help), plain text, manual pages and LaTeX or direct PDF output
  using rst2pdf
* Extensive cross-references: semantic markup and automatic links
  for functions, classes, glossary terms and similar pieces of information
* Hierarchical structure: easy definition of a document tree, with
automatic
  links to siblings, parents and children
* Automatic indices: general index as well as a module index
* Code handling: automatic highlighting using the Pygments highlighter
* Flexible HTML output using the Jinja 2 templating engine
* Various extensions are available, e.g. for automatic testing of snippets
  and inclusion of appropriately formatted docstrings
* Setuptools integration

For more information, refer to the `the documentation`__.

.. __: http://www.sphinx-doc.org/

Installation
============

Sphinx is published on `PyPI`__ and can be installed from there::

   pip install -U sphinx

We also publish beta releases::

   pip install -U --pre sphinx

If you wish to install `Sphinx` for development purposes, refer to `the
contributors guide`__.

__ https://pypi.org/project/Sphinx/
__ http://www.sphinx-doc.org/en/master/devguide.html

Documentation
=============

Documentation is available from `sphinx-doc.org`__.

__ http://www.sphinx-doc.org/

Get in touch
============

- Report bugs, suggest features or view the source code `on GitHub`_.
- For less well defined questions or ideas, use the `mailing list`_.

.. _on GitHub: https://github.com/sphinx-doc/sphinx
.. _mailing list: https://groups.google.com/forum/#!forum/sphinx-users

Testing
=======

Continuous testing is provided by `Travis`__ (for unit tests and style
checks
on Linux), `AppVeyor`__ (for unit tests on Windows), and `CircleCI`__ (for
large processes like TeX compilation).

For information on running tests locally, refer to `the contributors
guide`__.


[FILE:98:distinfo]
c1c00fc4f6e8b101a0d037065043460dffc2d507257f2f11acaed71fd2b0c83c      5754841 Sphinx-1.8.4.tar.gz