The Sphinx documentation generator
Go to file
adrian5 680030b568 Update conf.py.txt
I'm not entirely sure what this line is trying to say, but is needs rewriting. Modify my commit, if necessary.
2017-02-03 16:30:26 +01:00
.github refs #3222: add PULL_REQUEST_TEMPLATE.md 2016-12-18 01:20:55 +09:00
doc Update conf.py.txt 2017-02-03 16:30:26 +01:00
sphinx Merge pull request #3372 from tk0miya/move_docref_to_stddomain 2017-02-02 00:01:53 +09:00
tests Merge branch 'master' into move_docref_to_stddomain 2017-01-31 02:09:12 +09:00
utils Merge branch 'stable' 2017-01-22 17:36:03 +09:00
.gitignore Ignore .cache/ 2017-01-07 20:37:01 +09:00
.travis.yml Test pypy first to optimize Travis 2017-01-08 11:58:14 +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 Fix #3378: latex: Support `:widths:` option of table directives 2017-02-01 14:25:33 +09: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 add MoinMoin to EXAMPLES 2016-11-23 00:40:24 +09:00
LICENSE Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Makefile Merge branch 'stable' 2017-01-16 01:31:57 +09:00
MANIFEST.in remove MANIFEST.in file entries which doesn't exist 2017-01-17 14:13:31 +09:00
mypy.ini Prepare to type-check using mypy 2016-11-16 12:05:44 +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