annotate docs/index.rst @ 42:3794e7f4093e

Add sphinx-based documentation (for walkthrough, artist help, etc).
author Simon Cross <hodgestar+bzr@gmail.com>
date Mon, 23 Aug 2010 00:52:34 +0200
parents
children 7517a3cc06e7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
1 .. Boomslang documentation master file, created by
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
2 sphinx-quickstart on Mon Aug 23 00:49:49 2010.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
4 contain the root `toctree` directive.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
5
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
6 Welcome to Boomslang's documentation!
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
7 =====================================
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
8
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
9 Contents:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
10
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
11 .. toctree::
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
12 :maxdepth: 2
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
13
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
14 Indices and tables
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
15 ==================
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
16
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
17 * :ref:`genindex`
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
18 * :ref:`modindex`
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
19 * :ref:`search`
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
20