sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00

Go to file

Georg Brandl 2f09d24472 The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.

That means that the builtin sidebar contents can be included only selectively.

2010-01-07 17:56:09 +01:00

doc

The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.

2010-01-07 17:56:09 +01:00

sphinx

The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.

2010-01-07 17:56:09 +01:00

tests

The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.

2010-01-07 17:56:09 +01:00

utils

Update check_sources; we now have 201x.

2010-01-02 21:11:23 +01:00

.hgignore

Added a new theme inspired by the jinja / werkzeug theme.

2009-06-30 17:34:02 +01: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

The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered.

2010-01-07 17:56:09 +01:00

EXAMPLES

merge with 0.6

2010-01-02 20:54:59 +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

Update check_sources; we now have 201x.

2010-01-02 21:11:23 +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

Add i18n support, thanks to Horst Gutmann.

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

setup.py

Oops.

2009-10-22 18:07:31 +02: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.

Languages

Python 79.5%

JavaScript 11.5%

TeX 5.6%

Jinja 2.5%

HTML 0.6%

Other 0.2%