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
4,030 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%
a567d77e51
Go to file
Roland Meister a567d77e51 epub_use_index instead of html_use_index for epub builder (Issue #1106) 
The change adds the method get_builder_config.
This allows use of the option epub_use_index instead
of html_use_index for epub output.
2013-03-06 18:43:21 +01:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc epub_use_index instead of html_use_index for epub builder (Issue #1106) 2013-03-06 18:43:21 +01:00
sphinx epub_use_index instead of html_use_index for epub builder (Issue #1106) 2013-03-06 18:43:21 +01:00
tests Merged in knzm/sphinx-fix-docfields-fork (pull request #96) 2013-02-24 19:05:15 +09:00
utils Copyright update. 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 Fix uppercase word is not found in search when html_search_language='ja'. Closes #1111 2013-02-24 21:29:56 +09: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 CakePHP and Chef for EXAMPLES 2013-02-26 10:19:03 +09:00
LICENSE Copyright update. 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 Add setup.py "upload" alias for automatic package signing. 2013-02-05 09:19:52 +01: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 Copyright update. 2013-01-01 22:13:15 +01:00
sphinx-autogen.py Copyright update. 2013-01-01 22:13:15 +01:00
sphinx-build.py Copyright update. 2013-01-01 22:13:15 +01:00
sphinx-quickstart.py Copyright update. 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.