mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
31 lines
460 B
Plaintext
31 lines
460 B
Plaintext
=================
|
|
README for Sphinx
|
|
=================
|
|
|
|
Installing
|
|
==========
|
|
|
|
Use ``setup.py``::
|
|
|
|
python setup.py build
|
|
sudo python setup.py install
|
|
|
|
|
|
Reading the docs
|
|
================
|
|
|
|
After installing::
|
|
|
|
cd doc
|
|
sphinx-build . _build/html
|
|
|
|
Then, direct your browser to ``_build/html/index.html``.
|
|
|
|
Or read them online at <http://sphinx.pocoo.org/>.
|
|
|
|
|
|
Contributing
|
|
============
|
|
|
|
Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
|