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
516 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%
2e698fcb09
Go to file
Georg Brandl 2e698fcb09 Merged revisions 64642-64643,64698 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64642 | georg.brandl | 2008-07-01 23:02:35 +0200 (Tue, 01 Jul 2008) | 2 lines

  #3251: label names are case insensitive.
........
  r64643 | georg.brandl | 2008-07-01 23:24:55 +0200 (Tue, 01 Jul 2008) | 2 lines

  Add a note about decorated functions.
........
  r64698 | georg.brandl | 2008-07-04 12:21:09 +0200 (Fri, 04 Jul 2008) | 2 lines

  Allow setting current module to None.
........
2008-07-04 14:27:25 +00:00
doc Merged revisions 64642-64643,64698 via svnmerge from 2008-07-04 14:27:25 +00:00
sphinx Merged revisions 64642-64643,64698 via svnmerge from 2008-07-04 14:27:25 +00:00
tests Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00
utils Fix a few overlong lines, and use \t instead of literal tabs. 2008-03-21 15:27:21 +00:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
CHANGES Implemented JSONHTMLBuilder and improved JSON handling (it now prefers json from the 2.6 stdlib or simplejson). 2008-06-26 11:11:20 +00:00
EXAMPLES Add "who uses it" page. 2008-06-23 12:35:22 +00:00
ez_setup.py Add setup.py, add quickstart script. 2008-02-09 23:09:36 +00:00
LICENSE Add authors and license files. 2008-01-11 14:19:54 +00:00
Makefile Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00
README Add mkdir step to README. 2008-03-28 07:34:26 +00:00
setup.cfg Add new README, adapt setup.py. 2008-03-18 19:37:05 +00:00
setup.py Remove sphinx-web script. 2008-06-23 12:37:53 +00:00
sphinx-build.py Add shebangs. 2008-06-23 12:38:21 +00:00
sphinx-quickstart.py Add shebangs. 2008-06-23 12:38:21 +00:00
TODO Add default_role configuration value. 2008-06-17 10:06:37 +00:00

README 

=================
README for Sphinx
=================

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install


Reading the docs
================

After installing::

   cd doc
   mkdir -p _build/html
   sphinx-build . _build/html
   browser _build/index.html

Or read them online at <http://sphinx.pocoo.org/>.


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

Send wishes, comments, patches, etc. to georg@python.org.