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 drone.io:

Contributing

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There are Non Assigned issues: https://bitbucket.org/birkenfeld/sphinx/issues?status=new&status=open&responsible=
2. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email [email protected].
3. Fork the repository on Bitbucket https://bitbucket.org/birkenfeld/sphinx to start making your changes to the default 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://bitbucket.org/birkenfeld/sphinx/src/tip/AUTHORS> and the change to CHANGES <https://bitbucket.org/birkenfeld/sphinx/src/tip/CHANGES>.