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
545 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%
1f608000d8
Go to file
Georg Brandl 1f608000d8 Show Sphinx version in footer.
2008-08-04 16:38:04 +00:00
doc Add "env-updated" and "missing-reference" events. 2008-08-04 09:54:45 +00:00
sphinx Show Sphinx version in footer. 2008-08-04 16:38:04 +00:00
tests Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 2008-07-29 09:07:37 +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
CHANGES Add "env-updated" and "missing-reference" events. 2008-08-04 09:54:45 +00:00
EXAMPLES Added sympy 2008-07-05 23:35:45 +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 Merged revisions 65138,65145-65146,65268-65273 via svnmerge from 2008-07-29 09:07:37 +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 #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 "env-updated" and "missing-reference" events. 2008-08-04 09:54:45 +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.