IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
The Sphinx documentation generator
3,824 Commits 2 Branches 219 Tags 163 MiB
Python 79.5%
JavaScript 11.5%
TeX 5.6%
Jinja 2.5%
HTML 0.6%
Other 0.2%
567671f4d8
Go to file
Roland Meister 567671f4d8 Bug #1046: templating toctree() does not expand to maxdepth past maxdepth 
If the current page is nested larger than maxdepth it gets deleted
before it can be marked as current. The toctree then callapses to
the top entries. Split _walk_depth in two parts, first just add
the current tag, and remove unneeded entries in a second call.
2012-12-10 22:01:01 +01:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc Bug #1047: templating toctree()'s includehidden argument 2012-12-10 21:54:11 +01:00
sphinx Bug #1046: templating toctree() does not expand to maxdepth past maxdepth 2012-12-10 22:01:01 +01:00
tests merge heads 2012-12-10 10:18:32 +09:00
utils merge with 1.0 2011-01-04 11:29:09 +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 attribution for 9b4e41bba142. 2011-09-17 20:53:44 +02:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES Add Docutils-native XML and pseudo-XML builders 2012-12-04 21:10:15 -06: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 Closes #724: Add license for Underscore.js. 2011-06-28 20:37:29 +02: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 #98: Add autopackage script. (Undocumented for now.) 2011-01-04 19:20:22 +01:00
sphinx-autogen.py New year update. 2011-01-04 10:00:51 +01:00
sphinx-build.py New year update. 2011-01-04 10:00:51 +01:00
sphinx-quickstart.py New year update. 2011-01-04 10:00:51 +01:00
TODO Dummy change. 2009-10-26 09:30:43 +01:00
tox.ini Require Docutils 0.10 in tox py33 test env. 2012-11-03 09:37:35 -05: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.