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,112 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%
905ed46696
Go to file
Georg Brandl 905ed46696 There is now a `-W` option for sphinx-build that turns warnings into errors. 
^
2009-02-17 19:19:09 +01:00
doc There is now a `-W` option for sphinx-build that turns warnings into errors. 2009-02-17 19:19:09 +01:00
sphinx There is now a `-W` option for sphinx-build that turns warnings into errors. 2009-02-17 19:19:09 +01:00
tests Add theming test suite, fix a few bugs and doc problems. 2009-02-15 16:10:10 +01:00
utils Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
.hgignore Ignore .so files. 2008-12-30 02:37:01 +01:00
AUTHORS Added a toctree variable to the templates, and the ability to 2009-01-26 21:57:15 +01:00
babel.cfg Switched templating to jinja2 2008-11-20 20:05:45 +01:00
CHANGES There is now a `-W` option for sphinx-build that turns warnings into errors. 2009-02-17 19:19:09 +01:00
EXAMPLES Add Sprox. 2009-02-16 00:02:36 +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 Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
MANIFEST.in merge in trunk 2009-01-10 20:46:13 +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 Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +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.