sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-10 04:58:20 -05:00

T

Georg Brandl 346d9a9f8a Initialized merge tracking via "svnmerge" with revisions "1-64537" from

svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

2008-06-26 19:12:48 +00:00

doc

Fixed a syntax error in the builder documentation.

2008-06-26 11:13:44 +00:00

sphinx

Implemented JSONHTMLBuilder and improved JSON handling (it now prefers json from the 2.6 stdlib or simplejson).

2008-06-26 11:11:20 +00:00

tests

Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config.

2008-06-05 08:58:43 +00:00

utils

Fix a few overlong lines, and use \t instead of literal tabs.

2008-03-21 15:27:21 +00:00

AUTHORS

Armin deserves special mention.

2008-01-11 14:21:06 +00:00

CHANGES

Implemented JSONHTMLBuilder and improved JSON handling (it now prefers json from the 2.6 stdlib or simplejson).

2008-06-26 11:11:20 +00:00

EXAMPLES

Add "who uses it" page.

2008-06-23 12:35:22 +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

Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config.

2008-06-05 08:58:43 +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 default_role configuration value.

2008-06-17 10:06:37 +00:00

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.