sphinx

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

T

Armin Ronacher bd576bbe5d Properly parses operator definitions now. 'std:string

module::class::operator std::string()' is picked up properly.

2010-02-28 21:04:35 +01:00

doc

Add some domain documentation.

2010-03-01 14:22:14 +01:00

sphinx

Properly parses operator definitions now. 'std:string

2010-02-28 21:04:35 +01:00

tests

Fix test_markup.

2010-02-28 12:08:06 +01:00

utils

Remove obsolete todo entry.

2010-01-18 00:38:10 +01:00

.hgignore

Ignore emacs dir-locals.

2009-09-08 14:53:31 +02:00

AUTHORS

Add theme authors.

2010-01-07 11:49:48 +01:00

babel.cfg

Update POT file for new template locations.

2009-05-22 18:19:30 +02:00

CHANGES

merge with trunk

2010-02-28 15:24:47 +01:00

EXAMPLES

Add Blinker.

2010-02-28 09:19:00 +01:00

ez_setup.py

Update ez_setup.py.

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

LICENSE

Happy new year!

2010-01-01 14:09:13 +01:00

Makefile

merge with trunk

2010-01-07 19:07:50 +01:00

MANIFEST.in

Fix manifest. Again.

2009-03-28 14:51:45 -05:00

README

Mark up.

2009-03-09 09:42:05 +01:00

setup.cfg

Teach babel to extract l_() messages.

2009-07-03 13:37:38 +02:00

setup.py

Update blurb in setup.py and on the index page, link directly to tutorial.rst from index.

2010-02-28 23:12:00 +01:00

sphinx-autogen.py

Happy new year!

2010-01-01 14:09:13 +01:00

sphinx-build.py

Happy new year!

2010-01-01 14:09:13 +01:00

sphinx-quickstart.py

Happy new year!

2010-01-01 14:09:13 +01:00

TODO

Dummy change.

2009-10-26 09:30:43 +01:00

README

.. -*- restructuredtext -*-

=================
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.