Skip to content

goosemania/sphinx

 
 

Repository files navigation

Documentation Status https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master

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:

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

About

Main repository for the Sphinx documentation builder

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 68.6%
  • JavaScript 27.7%
  • TeX 2.3%
  • HTML 0.9%
  • CSS 0.4%
  • Makefile 0.1%