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,248 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%
0da0c03b53
Go to file
Roland Meister 0da0c03b53 Added the epub theme options relbar1 and footer.
2011-05-23 21:09:51 +02:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc Added the epub theme options relbar1 and footer. 2011-05-23 21:09:51 +02:00
sphinx Added the epub theme options relbar1 and footer. 2011-05-23 21:09:51 +02:00
tests #431: Doc comments for attributes can now be given on the same line as the assignment. 2011-01-15 15:40:59 +01: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
AUTHORS Add changelog entry and credits. 2011-01-08 18:45:07 +01:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES Group feature changelog by category. 2011-01-16 09:40:05 +01:00
distribute_setup.py update distribute_setup.py from http://python-distribute.org/distribute_setup.py 2010-06-15 23:16:33 +02:00
EXAMPLES Change redirected URLs to the new locations 2011-02-05 21:48:54 +01:00
LICENSE New year update. 2011-01-04 10:00:51 +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 Fix file name in manifest. 2010-08-11 17:16:20 +02:00
README Add some changes not picked up in the transplantation process. 2010-07-28 19:49:06 +02:00
setup.cfg Teach babel to extract l_() messages. 2009-07-03 13:37:38 +02:00
setup.py #98: Add autopackage script. (Undocumented for now.) 2011-01-04 19:20:22 +01: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 Backport tox.ini additions from trunk. 2011-01-15 16:17:42 +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/>.


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.