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
465 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%
e8bb912a9c
Go to file
Georg Brandl e8bb912a9c Factor out toctree resolution and add an option to ignore 
sublevel document headings.
2008-06-12 21:48:27 +00:00
doc Add a preliminary text writer, mainly for producing pydoc-compatible topic help. 2008-06-01 15:27:16 +00:00
sphinx Factor out toctree resolution and add an option to ignore 2008-06-12 21:48:27 +00:00
tests Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00
utils Fix a few overlong lines, and use \t instead of literal tabs. 2008-03-21 15:27:21 +00:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
CHANGES #3041: fix handling of unicode docstrings. 2008-06-05 17:06:34 +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 Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00
README Add mkdir step to README. 2008-03-28 07:34:26 +00:00
setup.cfg Add new README, adapt setup.py. 2008-03-18 19:37:05 +00:00
setup.py Next release will be beta status. 2008-05-06 16:14:21 +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 Add OpenSearch capability. 2008-04-27 18:08:55 +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
   mkdir -p _build/html
   sphinx-build . _build/html
   browser _build/index.html

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


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

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