Skip to content

Commit

Permalink
a couple more slides
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewschoen committed Apr 2, 2012
1 parent 77b8433 commit 8f8e7d7
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions index.rst
Expand Up @@ -41,8 +41,34 @@ After this completes, you're ready to start writing your docs!
reStructuredText
================

Sphinx uses reStructedText for the content of your docs. It's a bigger topic
than what I can cover here, but check out this primer on .rst

http://sphinx.pocoo.org/rest.html

Structuring your Docs
=====================

The root of your docs is the index.rst file (if you accepted the default
from ``sphinx-quickstart``)

Here, you'll define the table of contents for your docs. Linking to other
.rst files to create the structure.

::

.. toctree::
:maxdepth: 2

intro
tutorial
examples/first_example
examples/second_example

Building your Docs
==================



readthedocs.org integration
===========================

0 comments on commit 8f8e7d7

Please sign in to comment.