sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-19 01:14:45 -05:00

T

Armin Ronacher bf943483c0 attribute documentation now overrides non attribute documentation.

This makes it possible to document aliased methods and other things::

    def foo(self):
        pass

    #: an alias for foo()
    foo_alias = foo

Also attribute documentation can contain paragraphs now.

2009-02-05 13:28:46 +01:00

doc

The new `trim_footnote_reference_space` config value mirrors

2009-01-26 23:38:02 +01:00

sphinx

attribute documentation now overrides non attribute documentation.

2009-02-05 13:28:46 +01:00

tests

Add a minimal test for external toctree links and fix a small bug found by it.

2009-01-26 22:04:29 +01:00

utils

Some more license nits.

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

.hgignore

Ignore .so files.

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

AUTHORS

Added a toctree variable to the templates, and the ability to

2009-01-26 21:57:15 +01:00

babel.cfg

Switched templating to jinja2

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

CHANGES

Merge

2009-02-01 20:51:16 +01:00

EXAMPLES

Add WTForms.

2009-01-26 20:08:02 +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

Merged revisions 65566-65567,65623,65625 via svnmerge from

2008-08-10 16:59:27 +00:00

MANIFEST.in

Add Grammar.txt to Manifest.

2009-01-06 00:38:40 +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

Automated merge with http://bitbucket.org/birkenfeld/sphinx

2008-11-27 00:32:38 +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.