sphinx

0 Fork 0

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

T

Roland Meister 1639f59726 Add includehidden option to the toctree directive

This option is equivalent to the includehidden option of the template function
toctree() and allows to restore to the toctree behaviour prior to version 1.1.
See also bug #790.

2013-01-06 14:55:35 +01:00

custom_fixers

Rename __unicode__ to __str__

2010-05-09 14:57:18 +02:00

doc

Add includehidden option to the toctree directive

2013-01-06 14:55:35 +01:00

sphinx

Add includehidden option to the toctree directive

2013-01-06 14:55:35 +01:00

tests

merge birkenfeld/sphinx

2013-01-06 12:14:57 +01:00

utils

2013-01-01 22:13:15 +01:00

.hgignore

Ignore files generated when building the test docs

2010-11-02 13:15:18 +01:00

.travis.yml

Configure Travis CI.

2012-11-03 10:50:50 +01:00

AUTHORS

Add Hernan.

2013-01-03 10:11:18 +01:00

babel.cfg

Update POT file for new template locations.

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

CHANGES

Add includehidden option to the toctree directive

2013-01-06 14:55:35 +01:00

distribute_setup.py

Update distribute_setup.py to version 0.6.30 (http://python-distribute.org/distribute_setup.py )

2012-11-03 07:35:20 -05:00

EXAMPLES

Add the Ubuntu packaging guide.

2012-11-04 11:29:47 +01:00

LICENSE

2013-01-01 22:13:15 +01:00

Makefile

Ignore japanese search: it has long lines but breaking them would be ugly.

2011-01-15 16:01:14 +01:00

MANIFEST.in

Closes #809 : Include custom fixers in the source distribution.

2011-11-01 21:40:52 +01:00

README.rst

Update Sphinx URL to new sphinx-doc.org domain.

2012-11-04 11:28:12 +01:00

setup.cfg

Teach babel to extract l_() messages.

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

setup.py

Avoid unknown option warnings for use_2to3 in setup.py under Python 2.

2012-11-11 01:33:52 -06:00

sphinx-apidoc.py

2013-01-01 22:13:15 +01:00

sphinx-autogen.py

2013-01-01 22:13:15 +01:00

sphinx-build.py

2013-01-01 22:13:15 +01:00

sphinx-quickstart.py

2013-01-01 22:13:15 +01:00

TODO

Dummy change.

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

tox.ini

remove comment-outed docutils repository for py33 test

2013-01-01 15:29:43 +09:00

README.rst

=================
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-doc.org/>.


Testing
=======

To run the tests with the interpreter available as ``python``, use::

    make test

If you want to use a different interpreter, e.g. ``python3``, use::

    PYTHON=python3 make test


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

Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.