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,305 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%
02a53d74e9
Go to file
Georg Brandl 02a53d74e9 Add sqlparse.
2009-04-09 19:07:15 +00:00
doc Add html_show_copyright config val, patch by Wojtek Walczak. 2009-04-09 19:04:44 +00:00
sphinx Add html_show_copyright config val, patch by Wojtek Walczak. 2009-04-09 19:04:44 +00: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 Add html_show_copyright config val, patch by Wojtek Walczak. 2009-04-09 19:04:44 +00:00
EXAMPLES Add sqlparse. 2009-04-09 19:07:15 +00: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.