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
879 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%
c74163d0a0
Go to file
Georg Brandl c74163d0a0 The `toctree directive now supports a :hidden:` flag, 
which will prevent links from being generated in place of
the directive -- this allows you to define your document
structure, but place the links yourself.
2008-12-20 23:23:39 +01:00
doc The `toctree directive now supports a :hidden:` flag, 2008-12-20 23:23:39 +01:00
sphinx The `toctree directive now supports a :hidden:` flag, 2008-12-20 23:23:39 +01:00
tests The `autodoc_skip_member` event now also gets to decide 2008-12-15 12:49:40 +01:00
utils Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 2008-07-18 22:55:36 +00:00
.hgignore Add TAGS. 2008-11-16 09:16:17 +01:00
AUTHORS Armin deserves special mention. 2008-01-11 14:21:06 +00:00
babel.cfg Add translation of strings in JavaScript files. 2008-09-06 17:36:25 +00:00
CHANGES The `toctree directive now supports a :hidden:` flag, 2008-12-20 23:23:39 +01:00
EXAMPLES Add SQLAlchemy. 2008-12-17 22:51:07 +01:00
ez_setup.py Update ez_setup.py. 2008-11-23 19:50:56 +01:00
LICENSE Add authors and license files. 2008-01-11 14:19:54 +00:00
Makefile Merged revisions 65566-65567,65623,65625 via svnmerge from 2008-08-10 16:59:27 +00:00
MANIFEST.in Use * instead of *.* as glob pattern, catches Makefile. 2008-11-04 19:51:38 +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 Add text output format. 2008-11-23 19:13:15 +01:00
sphinx-build.py Make the scripts executable. 2008-11-04 08:40:19 +01:00
sphinx-quickstart.py Make the scripts executable. 2008-11-04 08:40:19 +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.