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
876 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%
da7f1e408c
Go to file
Georg Brandl da7f1e408c Relicense to avoid confusion.
2009-03-09 14:25:36 +01:00
doc Note that Python code in code blocks is parsed. 2009-02-23 19:23:08 +01:00
sphinx Fix a linking problem in latex. 2009-03-05 09:52:26 +01:00
tests Switch copyright and license tags to single style. Add contributor 2009-01-03 11:57:07 +01:00
utils Relicense to avoid confusion. 2009-03-09 14:25:36 +01:00
.hgignore Add TAGS. 2008-11-16 09:16:17 +01:00
AUTHORS Switch copyright and license tags to single style. Add contributor 2009-01-03 11:57:07 +01:00
babel.cfg Add translation of strings in JavaScript files. 2008-09-06 17:36:25 +00:00
CHANGES #71: If a decoding error occurs in source files, print a warning and replace the characters by "?". 2009-02-21 19:58:52 +01:00
EXAMPLES Add SQLAlchemy. 2008-12-17 22:51:07 +01:00
ez_setup.py Update ez_setup.py. 2008-11-23 19:50:56 +01:00
LICENSE Some more license nits. 2009-01-03 12:15:04 +01:00
Makefile Merged revisions 65566-65567,65623,65625 via svnmerge from 2008-08-10 16:59:27 +00:00
MANIFEST.in Use * instead of *.* as glob pattern, catches Makefile. 2008-11-04 19:51:38 +01:00
README Fix #53, a few nits in the README. 2008-11-24 20:33:58 +01:00
setup.cfg Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
setup.py Depend on Jinja 1.2; 1.1 has a small bug in operator precedence that causes overzealous escaping in our templates. 2009-02-19 16:07:50 +01:00
sphinx-build.py Some more license nits. 2009-01-03 12:15:04 +01:00
sphinx-quickstart.py Some more license nits. 2009-01-03 12:15:04 +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
   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.