IntenseWebs/sphinx: The Sphinx documentation generator - sphinx - Git Repository of IntenseWebs.com, IF.Finance, IWeb.City, NuKVM.org, OilfieldTools Network, Spartan International Drilling, Green Polymer Products & more

IntenseWebs/sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-07-31 08:38:07 -05:00

T

Georg Brandl 799bc4fefe #188 : fix oversight in replacing parameter.

2009-06-01 10:40:17 +02:00

Set the default encoding to `utf-8-sig` to handle files with a

2009-05-31 18:58:28 +02:00

#188 : fix oversight in replacing parameter.

2009-06-01 10:40:17 +02:00

Don't consider contents of source comments for the search index.

2009-05-31 19:47:42 +02:00

merge with 0.5

2009-03-09 14:25:52 +01:00

.hgignore

#146 : Don't fail to generate LaTeX when the user has an active

2009-05-03 10:32:32 +02: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

Update POT file for new template locations.

2009-05-22 18:19:30 +02:00

CHANGES

Don't consider contents of source comments for the search index.

2009-05-31 19:47:42 +02:00

EXAMPLES

Add GeoServer.

2009-05-17 12:10:19 +02: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

#157 : fix make check.

2009-05-10 20:59:08 +02: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

Provide a ==dev egg link in pkg-info.

2009-05-17 12:39:43 +02: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.