The Sphinx documentation generator
Go to file
jfbu e39d58a530 LaTeX writer: symmetrize footnote restrictions for tables
Memo 1: footnotes from captions are inserted by this commit via
table templates, so it is easy to put caption at foot of table
rather than at head, if wanted.

Memo 2: footnotes from table header need restriction due to
longtable only. But one can not tell in advance if table will be
rendered by longtable or not, hence one must restrict always.
2017-02-18 12:38:59 +01:00
.github refs #3222: add PULL_REQUEST_TEMPLATE.md 2016-12-18 01:20:55 +09:00
doc Update CHANGES and docs for PR#3413 2017-02-17 23:30:01 +01:00
sphinx LaTeX writer: symmetrize footnote restrictions for tables 2017-02-18 12:38:59 +01:00
tests (latex) hyperlinked footnotes from table bodies 2017-02-18 12:36:28 +01:00
utils Reduce DeprecationWarnings for regexp 2017-02-17 02:01:04 +09:00
.gitignore Ignore .cache/ 2017-01-07 20:37:01 +09:00
.travis.yml travis: Specify the version of pypy to avoid travis's issue 2017-02-13 21:40:12 +09:00
AUTHORS Preserved alphabetically order in author list 2017-01-24 14:06:59 +01:00
babel.cfg Added improvements about i18n for themes "basic", "haiku" and "scrolls" that Sphinx built-in. Closes #1120 2013-03-04 10:35:30 -05:30
CHANGES (latex) hyperlinked footnotes from table bodies 2017-02-18 12:36:28 +01:00
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file 2013-03-29 13:05:49 +01:00
CONTRIBUTING.rst Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst. 2016-12-18 00:10:40 +09:00
EXAMPLES Fixed some broken URLs in "Projects using Sphinx" 2017-02-08 14:14:50 +01:00
LICENSE Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Makefile Reduce DeprecationWarnings for regexp 2017-02-17 02:01:04 +09:00
MANIFEST.in remove MANIFEST.in file entries which doesn't exist 2017-01-17 14:13:31 +09:00
mypy.ini Remove unused "type: ignore" 2017-02-06 15:21:19 +09:00
README.rst move badge to top. and add another badge. 2016-12-18 00:22:05 +09:00
setup.cfg Fix flake8 violations 2017-01-26 01:13:17 +09:00
setup.py Merge branch 'stable' 2017-01-29 18:05:17 +09:00
sphinx-apidoc.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-autogen.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-build.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-quickstart.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
test-reqs.txt Merge branch 'stable' 2017-01-10 01:04:21 +09:00
tox.ini Merge branch 'stable' 2017-01-07 15:36:55 +09:00

.. image:: https://img.shields.io/pypi/v/sphinx.svg
   :target: http://pypi.python.org/pypi/sphinx
.. image:: https://readthedocs.org/projects/sphinx/badge/
   :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

=================
README for Sphinx
=================

This is the Sphinx documentation generator, see http://www.sphinx-doc.org/.


Installing
==========

Install from PyPI to use stable version::

   pip install -U sphinx

Install from PyPI to use beta version::

   pip install -U --pre sphinx

Install from newest dev version in stable branch::

   pip install git+https://github.com/sphinx-doc/sphinx@stable

Install from newest dev version in master branch::

   pip install git+https://github.com/sphinx-doc/sphinx

Install from cloned source::

   pip install .

Install from cloned source as editable::

   pip install -e .


Release signatures
==================

Releases are signed with following keys:

* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_

Reading the docs
================

You can read them online at <http://www.sphinx-doc.org/>.

Or, after installing::

   cd doc
   make html

Then, direct your browser to ``_build/html/index.html``.

Testing
=======

To run the tests with the interpreter available as ``python``, use::

    make test

If you want to use a different interpreter, e.g. ``python3``, use::

    PYTHON=python3 make test

Continuous testing runs on travis: https://travis-ci.org/sphinx-doc/sphinx


Contributing
============

See `CONTRIBUTING.rst`__

.. __: CONTRIBUTING.rst