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
2,587 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%
020daea23f
Go to file
Georg Brandl 020daea23f Fix #704: image file duplication bug.
2011-09-22 11:30:06 +02:00
doc Closes #658: fix error in script_files example and document css_files. 2011-05-15 13:05:31 +02:00
sphinx Fix #704: image file duplication bug. 2011-09-22 11:30:06 +02:00
tests Fix #677: allow multiple signatures in C++ domain directives. 2011-09-22 10:23:54 +02:00
utils New year update. 2011-01-04 10:00:51 +01:00
.hgignore Fix :guilabel: unescaping, and make some tests actually run. 2010-07-21 11:33:24 +01:00
AUTHORS In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option. 2010-05-24 23:14:35 +02:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES Fix #704: image file duplication bug. 2011-09-22 11:30:06 +02:00
EXAMPLES Add some more examples. 2011-01-15 10:23:51 +01:00
ez_setup.py Update ez_setup.py. 2008-11-23 19:50:56 +01:00
LICENSE New year update. 2011-01-04 10:00:51 +01:00
Makefile Make make check happy. 2010-07-23 12:38:41 +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 Teach babel to extract l_() messages. 2009-07-03 13:37:38 +02:00
setup.py Update for 1.0. 2010-07-23 12:42:03 +01:00
sphinx-autogen.py New year update. 2011-01-04 10:00:51 +01:00
sphinx-build.py New year update. 2011-01-04 10:00:51 +01:00
sphinx-quickstart.py New year update. 2011-01-04 10:00:51 +01:00
TODO Dummy change. 2009-10-26 09:30:43 +01:00
tox.ini Backport tox.ini additions from trunk. 2011-01-15 16:17:42 +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.