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
590 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%
87a05a41cb
Go to file
Georg Brandl 87a05a41cb Merged revisions 66061,66069 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r66061 | georg.brandl | 2008-08-30 11:43:20 +0200 (Sat, 30 Aug 2008) | 2 lines

  Show last released version in built docs.
........
  r66069 | georg.brandl | 2008-08-30 15:21:40 +0200 (Sat, 30 Aug 2008) | 2 lines

  XeTeX fix by Markus Gritsch.
........
2008-08-30 21:56:43 +00:00
doc Merged revisions 66061,66069 via svnmerge from 2008-08-30 21:56:43 +00:00
sphinx Merged revisions 66061,66069 via svnmerge from 2008-08-30 21:56:43 +00:00
tests Merged revisions 65640,65675,65699,65701 via svnmerge from 2008-08-23 15:04:45 +00:00
utils Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 2008-07-18 22:55:36 +00:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
babel.cfg Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
CHANGES Respect __all__ when autodocumenting module members. 2008-08-15 19:43:52 +00:00
EXAMPLES Link to group instead of direct email link. 2008-08-08 15:44:23 +00:00
ez_setup.py Merged revisions 65283,65303,65316-65317,65372-65375,65377,65380,65483-65485,65494 via svnmerge from 2008-08-04 17:01:15 +00:00
LICENSE Add authors and license files. 2008-01-11 14:19:54 +00:00
Makefile Merged revisions 65566-65567,65623,65625 via svnmerge from 2008-08-10 16:59:27 +00:00
README Add mkdir step to README. 2008-03-28 07:34:26 +00:00
setup.cfg Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
setup.py #3422: allow changing the signature of functions via a new hook. 2008-07-29 18:30:23 +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 todo item. 2008-08-23 14:53:14 +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.