sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00

T

Georg Brandl d4f5796f3b The HTML builder now stores a small file named `.buildinfo` in

its output directory.  It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing ``html_theme``).

2009-02-19 16:15:36 +01:00

doc

The HTML builder now stores a small file named `.buildinfo` in

2009-02-19 16:15:36 +01:00

sphinx

The HTML builder now stores a small file named `.buildinfo` in

2009-02-19 16:15:36 +01:00

tests

Test add_description_unit in test suite.

2009-02-18 22:12:03 +01:00

utils

Fix more line length and trailing whitespace.

2009-01-10 22:18:18 +01:00

.hgignore

Ignore .so files.

2008-12-30 02:37:01 +01:00

AUTHORS

Add DirectoryHTMLBuilder (contributed as PrettyHTMLBuilder by Will Maier).

2009-02-19 00:07:47 +01:00

babel.cfg

Switched templating to jinja2

2008-11-20 20:05:45 +01:00

CHANGES

The HTML builder now stores a small file named `.buildinfo` in

2009-02-19 16:15:36 +01:00

EXAMPLES

Add Sprox.

2009-02-16 00:02:36 +01:00

ez_setup.py

Update ez_setup.py.

2008-11-23 19:50:56 +01:00

LICENSE

Add JQuery license; add PSF copyright statement.

2009-01-05 00:04:53 +01:00

Makefile

Fix more line length and trailing whitespace.

2009-01-10 22:18:18 +01:00

MANIFEST.in

merge in trunk

2009-01-10 20:46:13 +01:00

README

Fix #53 , a few nits in the README.

2008-11-24 20:33:58 +01:00

setup.cfg

Add i18n support, thanks to Horst Gutmann.

2008-08-08 10:54:00 +00:00

setup.py

Fix more line length and trailing whitespace.

2009-01-10 22:18:18 +01:00

sphinx-build.py

Some more license nits.

2009-01-03 12:15:04 +01:00

sphinx-quickstart.py

Some more license nits.

2009-01-03 12:15:04 +01:00

TODO

change tracker url

2008-11-04 02:34:12 +01: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
   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.