Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Main repository for the Sphinx documentation builder
Failed to load latest commit information.
doc fix http/https
sphinx Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
tests Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
utils Merge branch 'stable'
.gitignore add a .gitignore file, remove .hgignore
.travis.yml Try to work around travis connection issues, see travis-ci/travis-ci#…
AUTHORS Add name to AUTHORS file
CHANGES Closes #1748: SyntaxError in sphinx/ext/ifconfig.py with Python 2.6.
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file
EXAMPLES Closes #1735: Use https://doc.python.org/ instead of ``http`` protoco…
LICENSE Merge branch 'stable'
MANIFEST.in remove custom_fixers from MANIFEST.in. that directory already removed…
Makefile fix trailing space and long line
README.rst Correct few "typos".
babel.cfg Added improvements about i18n for themes "basic", "haiku" and "scroll…
ez_setup.py update bundled ez_setup.py for setuptools-7.0 that requires Python 2.…
setup.cfg Use universal wheel package. removing build directory procedure is no…
setup.py fix http/https
sphinx-apidoc.py all: update copyright
sphinx-autogen.py all: update copyright
sphinx-build.py all: update copyright
sphinx-quickstart.py all: update copyright
test-reqs.txt fix missing test requires
tox.ini Complete test suite overhaul.

README.rst

README for Sphinx

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

Installing

Use setup.py:

python setup.py build
sudo python setup.py install

Reading the docs

After installing:

cd doc
make html

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

Or read them online at <http://sphinx-doc.org/>.

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.svg?branch=master

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email sphinx-dev@googlegroups.com.
  3. Fork the repository on GitHub https://github.com/sphinx-doc/sphinx to start making your changes to the master branch for next major version, or stable branch for next minor version.
  4. Write a test which shows that the bug was fixed or that the feature works as expected.
  5. Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS <https://github.com/sphinx-doc/sphinx/blob/master/AUTHORS> and the change to CHANGES <https://github.com/sphinx-doc/sphinx/blob/master/CHANGES>.
Something went wrong with that request. Please try again.