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
Python JavaScript TeX HTML Other

Closes #1831: [Napoleon] If name is not found in NumPy Doc Returns se…

…ction, regard the whole line as the type
latest commit 80eb821ec8
@RobRuana RobRuana authored
Failed to load latest commit information.
doc speicifer -> specifier
sphinx Closes #1831: [Napoleon] If name is not found in NumPy Doc Returns se…
tests Closes #1831: [Napoleon] If name is not found in NumPy Doc Returns se…
utils fix for `make check`
.gitignore add a .gitignore file, remove .hgignore
.travis.yml add flake8 check to travis
AUTHORS Update CHANGES and AUTHORS. Closes #1765.
CHANGES Fix #1790 literalinclude strips empty lines at the head and tail
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file
EXAMPLES remove or update missing links.
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 Support PEP-440 version spec for developers.
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 Support PEP-440 version spec for developers.
setup.py Merge pull request #1759 from bitprophet/patch-1
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 add flake8 testing
tox.ini add flake8 testing

README.rst

README for Sphinx

This is the Sphinx documentation generator, see http://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 .

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. Use make test to run the test suite.
  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.