README

=================
README for Sphinx
=================

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install


Reading the docs
================

After installing::

   cd doc
   mkdir -p _build/html
   sphinx-build . _build/html
   browser _build/index.html

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


Contributing
============

Send wishes, comments, patches, etc. to georg@python.org.
Add new README, adapt setup.py. 2008-03-18 19:37:05 +00:00			`=================`
			`README for Sphinx`
			`=================`

			`Installing`
			`==========`

			Use ``setup.py``::

			`python setup.py build`
			`sudo python setup.py install`


			`Reading the docs`
			`================`

			`After installing::`

			`cd doc`
Add mkdir step to README. 2008-03-28 07:34:26 +00:00			`mkdir -p _build/html`
Don't install scripts twice. Thanks to lunar. 2008-03-23 17:43:22 +00:00			`sphinx-build . _build/html`
			`browser _build/index.html`
Add new README, adapt setup.py. 2008-03-18 19:37:05 +00:00
			`Or read them online at <http://sphinx.pocoo.org/>.`


			`Contributing`
			`============`

			`Send wishes, comments, patches, etc. to georg@python.org.`