The Sphinx documentation generator
Go to file
Georg Brandl 6c2f991be0 Merged revisions 65138,65145-65146,65268-65273 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65138 | georg.brandl | 2008-07-19 15:42:35 +0200 (Sat, 19 Jul 2008) | 2 lines

  #3416: fix missing parameter.
........
  r65145 | georg.brandl | 2008-07-19 20:01:25 +0200 (Sat, 19 Jul 2008) | 2 lines

  Now that we don't ship Jinja anymore by default the comment can go.
........
  r65146 | georg.brandl | 2008-07-19 20:01:51 +0200 (Sat, 19 Jul 2008) | 2 lines

  Reread documents with globbed toctrees when files are removed/added.
........
  r65268 | georg.brandl | 2008-07-29 10:21:33 +0200 (Tue, 29 Jul 2008) | 2 lines

  Fix by Markus Gritsch to place correct links to headings.
........
  r65269 | georg.brandl | 2008-07-29 10:21:59 +0200 (Tue, 29 Jul 2008) | 2 lines

  Make the writer's settings public.
........
  r65270 | georg.brandl | 2008-07-29 10:22:28 +0200 (Tue, 29 Jul 2008) | 2 lines

  Export test_root.
........
  r65271 | georg.brandl | 2008-07-29 10:22:47 +0200 (Tue, 29 Jul 2008) | 2 lines

  Add a markup test.
........
  r65272 | georg.brandl | 2008-07-29 10:27:19 +0200 (Tue, 29 Jul 2008) | 2 lines

  Bump version number.
........
  r65273 | georg.brandl | 2008-07-29 11:05:37 +0200 (Tue, 29 Jul 2008) | 2 lines

  Correct rendering of ``samp``.
........
2008-07-29 09:07:37 +00:00
doc Remove the opcode directive. 2008-07-23 15:18:00 +00:00
sphinx Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 2008-07-29 09:07:37 +00:00
tests Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 2008-07-29 09:07:37 +00:00
utils Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 2008-07-18 22:55:36 +00:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
CHANGES Fixed docstring dedenting and made the html writer more configurable in the sense that it doesn't change behavior based on the builder name any longer. 2008-07-10 13:59:59 +00:00
EXAMPLES Added sympy 2008-07-05 23:35:45 +00:00
ez_setup.py Add setup.py, add quickstart script. 2008-02-09 23:09:36 +00:00
LICENSE Add authors and license files. 2008-01-11 14:19:54 +00:00
Makefile Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 2008-07-29 09:07:37 +00:00
README Add mkdir step to README. 2008-03-28 07:34:26 +00:00
setup.cfg Add new README, adapt setup.py. 2008-03-18 19:37:05 +00:00
setup.py Remove sphinx-web script. 2008-06-23 12:37:53 +00:00
sphinx-build.py Add shebangs. 2008-06-23 12:38:21 +00:00
sphinx-quickstart.py Add shebangs. 2008-06-23 12:38:21 +00:00
TODO Add item. 2008-07-29 09:06: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
   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.