sphinx

0 Fork 0

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-14 01:12:10 -05:00

T

Georg Brandl e0bdea6b28 Render .. automodule:: docstrings in a section node, and

ignore section styles in the document, so that module docstrings
can contain proper sections.

2008-03-23 08:28:14 +00:00

doc

Also remove # doctest: directives in presentation output.

2008-03-22 21:21:28 +00:00

sphinx

Render .. automodule:: docstrings in a section node, and

2008-03-23 08:28:14 +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

Render .. automodule:: docstrings in a section node, and

2008-03-23 08:28:14 +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

Some pylint fixes.

2008-03-16 13:12:48 +00:00

README

Add new README, adapt setup.py.

2008-03-18 19:37:05 +00:00

setup.cfg

Add new README, adapt setup.py.

2008-03-18 19:37:05 +00:00

setup.py

Remove unicode characters from description.

2008-03-21 17:22:42 +00:00

sphinx-build.py

More refactoring, this time allowing different file extensions

2008-02-01 20:44:17 +00:00

sphinx-quickstart.py

Add setup.py, add quickstart script.

2008-02-09 23:09:36 +00:00

sphinx-web.py

sphinx.web is currently broken.

2008-03-16 11:44:35 +00:00

TODO

Checkin my holiday work:

2007-12-29 10:58:10 +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
   sphinx-build.py . .build
   browser .build/index.html

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


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

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