2008-03-18 14:37:05 -05:00
|
|
|
=================
|
|
|
|
|
README for Sphinx
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
Installing
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
Use ``setup.py``::
|
|
|
|
|
|
|
|
|
|
python setup.py build
|
|
|
|
|
sudo python setup.py install
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reading the docs
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
After installing::
|
|
|
|
|
|
|
|
|
|
cd doc
|
2008-03-23 12:43:22 -05:00
|
|
|
sphinx-build . _build/html
|
2008-11-24 13:33:58 -06:00
|
|
|
|
|
|
|
|
Then, direct your browser to ``_build/html/index.html``.
|
2008-03-18 14:37:05 -05:00
|
|
|
|
2012-11-04 04:28:12 -06:00
|
|
|
Or read them online at <http://sphinx-doc.org/>.
|
2008-03-18 14:37:05 -05:00
|
|
|
|
|
|
|
|
|
2010-07-28 12:49:06 -05:00
|
|
|
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
|
|
|
|
|
|
2015-01-02 06:54:04 -06:00
|
|
|
Continuous testing runs on travis:
|
|
|
|
|
|
|
|
|
|
.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
|
|
|
|
|
:target: https://travis-ci.org/sphinx-doc/sphinx
|
|
|
|
|
|
2010-07-28 12:49:06 -05:00
|
|
|
|
2008-03-18 14:37:05 -05:00
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
2008-11-24 13:33:58 -06:00
|
|
|
Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
|
