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,476 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%
a7ca488a8e
Go to file
Daniel Neuhäuser a7ca488a8e Removed XMLParser._fixtext which fixes several errors in the test suite
2010-07-10 19:47:32 +02:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc Go to #pocoo. 2010-07-28 14:53:39 +02:00
sphinx Fixed warnings in python3 2010-06-20 22:39:38 +02:00
tests Removed XMLParser._fixtext which fixes several errors in the test suite 2010-07-10 19:47:32 +02:00
utils Added latest reindent.py file 2010-05-17 02:26:31 +02:00
.hgignore Ignore generated files 2010-05-16 22:27:05 +02:00
AUTHORS In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option. 2010-05-24 23:14:35 +02:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES merge with 1.0 2010-07-27 19:53:05 +02:00
CHANGES.DasIch Added latest changes to the Changes.DasIch file 2010-05-17 02:23:59 +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 Changed documentation URL by request 2010-07-26 05:16:00 +02:00
LICENSE Happy new year! 2010-01-01 14:09:13 +01:00
Makefile make now works without python3 2010-05-23 01:34:52 +02:00
MANIFEST.in Add setup_distribute.py to MANIFEST.in and remove ez_setup.py 2010-05-16 16:20:44 +02:00
README Mark up. 2009-03-09 09:42:05 +01:00
setup.cfg Teach babel to extract l_() messages. 2009-07-03 13:37:38 +02:00
setup.py Rename __unicode__ to __str__ 2010-05-09 14:57:18 +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/>.


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

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