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
2,952 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%
4cb330f8a6
Go to file
Georg Brandl 4cb330f8a6 #526: Add Iranian translation, thanks to Omid Raha.
2010-10-22 13:24:17 +02:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc #526: Add Iranian translation, thanks to Omid Raha. 2010-10-22 13:24:17 +02:00
sphinx #526: Add Iranian translation, thanks to Omid Raha. 2010-10-22 13:24:17 +02:00
tests Implement missing node handlers for texinfo. Enable checking warnings from texinfo build in tests. 2010-10-22 11:27:33 +02:00
utils Added latest reindent.py file 2010-05-17 02:26:31 +02:00
.hgignore Ignore distribute files. 2010-07-28 19:58:47 +02:00
AUTHORS Few cleanups after texinfo builder merge (#529). Add CHANGES and AUTHORS entries. To do: add node handlers for all extension nodes so that the test documents can be handled without warnings. 2010-10-22 10:17:35 +02:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES #526: Add Iranian translation, thanks to Omid Raha. 2010-10-22 13:24:17 +02: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 merge with 1.0 2010-10-22 11:16:48 +02:00
LICENSE Happy new year! 2010-01-01 14:09:13 +01:00
Makefile Update phony targets list. 2010-07-28 20:30:05 +02: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 Invert setup.py uuid logic. 2010-08-21 22:14:57 +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
tox.ini Add docutils 0.7 target. 2010-07-26 19:31:07 +02: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.