Skip to content

goosemania/sphinx

This branch is 13184 commits behind sphinx-doc/sphinx:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0008d57 · May 18, 2017
May 11, 2017
Dec 17, 2016
May 14, 2017
May 18, 2017
May 16, 2017
May 16, 2017
Jan 7, 2017
May 11, 2017
Apr 22, 2017
May 18, 2017
Mar 29, 2013
May 14, 2017
Feb 8, 2017
May 13, 2017
Jan 17, 2017
Apr 24, 2017
Dec 17, 2016
Mar 4, 2013
May 7, 2017
Apr 2, 2017
May 3, 2017
May 9, 2017
May 9, 2017
May 9, 2017
May 9, 2017
May 7, 2017
May 3, 2017

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%