sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00

Go to file

Georg Brandl d8c601b4cd * Allow the ~ prefix on module xrefs.

* The parse function for custom descitems must return the full name for x-refing.

2008-03-21 14:00:34 +00:00

doc

Make it possible to deactivate the module index.

2008-03-18 19:54:45 +00:00

sphinx

* Allow the ~ prefix on module xrefs.

2008-03-21 14:00:34 +00:00

utils

Some pylint fixes.

2008-03-16 13:12:48 +00:00

AUTHORS

Armin deserves special mention.

2008-01-11 14:21:06 +00:00

ez_setup.py

Add setup.py, add quickstart script.

2008-02-09 23:09:36 +00:00

LICENSE

Add authors and license files.

2008-01-11 14:19:54 +00:00

Makefile

Some pylint fixes.

2008-03-16 13:12:48 +00:00

README

Add new README, adapt setup.py.

2008-03-18 19:37:05 +00:00

setup.cfg

Add new README, adapt setup.py.

2008-03-18 19:37:05 +00:00

setup.py

Add new README, adapt setup.py.

2008-03-18 19:37:05 +00:00

sphinx-build.py

More refactoring, this time allowing different file extensions

2008-02-01 20:44:17 +00:00

sphinx-quickstart.py

Add setup.py, add quickstart script.

2008-02-09 23:09:36 +00:00

sphinx-web.py

sphinx.web is currently broken.

2008-03-16 11:44:35 +00:00

TODO

Checkin my holiday work:

2007-12-29 10:58:10 +00: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.py . .build
   browser .build/index.html

Or read them online at <http://sphinx.pocoo.org/>.


Contributing
============

Send wishes, comments, patches, etc. to georg@python.org.

Languages

Python 79.5%

JavaScript 11.5%

TeX 5.6%

Jinja 2.5%

HTML 0.6%

Other 0.2%