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
1,296 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%
cb86f75bab
Go to file
Georg Brandl cb86f75bab In the LaTeX writer, do not raise an exception on too many section 
levels, just use the "subparagraph" level for all of them.
2009-04-28 20:31:00 +02:00
doc Add a FAQ item. 2009-03-31 16:50:09 -05:00
sphinx In the LaTeX writer, do not raise an exception on too many section 2009-04-28 20:31:00 +02:00
tests Fix test suite failures when Pygments is not available. 2009-04-07 21:50:14 +02:00
utils merge with 0.5 2009-03-09 14:25:52 +01:00
.hgignore Add coverage output file. 2009-02-23 19:24:22 +01:00
AUTHORS Remove extra autosummary license since Sphinx now uses 2-clause BSD as well. 2009-03-14 21:16:20 +01:00
babel.cfg Switched templating to jinja2 2008-11-20 20:05:45 +01:00
CHANGES In the LaTeX writer, do not raise an exception on too many section 2009-04-28 20:31:00 +02:00
EXAMPLES Add Sage. 2009-03-16 01:11:33 +01:00
ez_setup.py Update ez_setup.py. 2008-11-23 19:50:56 +01:00
LICENSE Add JQuery license; add PSF copyright statement. 2009-01-05 00:04:53 +01:00
Makefile Add makefile target for easy test coverage checking. 2009-02-22 19:00:36 +01:00
MANIFEST.in Fix manifest. Again. 2009-03-28 14:51:45 -05:00
README Mark up. 2009-03-09 09:42:05 +01:00
setup.cfg Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
setup.py merge with autosummary branch 2009-03-14 21:14:48 +01:00
sphinx-autogen.py Work a bit on coding style of autosummary. 2009-03-14 21:08:52 +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 

.. -*- restructuredtext -*-

=================
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.