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
712 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%
af94c01319
Go to file
Georg Brandl af94c01319 Make the scripts executable.
2008-11-04 08:40:19 +01:00
doc Correct parameter name in example. 2008-11-04 08:20:18 +01:00
sphinx Add -A option to pass values into HTML templates. 2008-11-04 08:34:35 +01:00
tests Add -A option to pass values into HTML templates. 2008-11-04 08:34:35 +01:00
utils Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 2008-07-18 22:55:36 +00:00
.hgignore More things to ignore. 2008-11-02 23:33:19 +01:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
babel.cfg Add translation of strings in JavaScript files. 2008-09-06 17:36:25 +00:00
CHANGES #29: fix some option list issues, in HTML, LaTeX and text writers. 2008-11-03 21:40:21 +01:00
EXAMPLES More examples. 2008-10-28 08:31:42 +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
MANIFEST.in Add a manifest, since setuptools doesn't support hg. 2008-11-02 23:32:15 +01: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 Add a manifest, since setuptools doesn't support hg. 2008-11-02 23:32:15 +01:00
sphinx-build.py Make the scripts executable. 2008-11-04 08:40:19 +01:00
sphinx-quickstart.py Make the scripts executable. 2008-11-04 08:40:19 +01:00
TODO change tracker url 2008-11-04 02:34:12 +01: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.