Sphinx Tutorial

September 5, 2015 ยท View on GitHub

=============== Sphinx Tutorial

Welcome to the Introduction to Sphinx & Read the Docs. This tutorial will walk you through the initial steps writing reStructuredText and Sphinx, and deploying that code to Read the Docs.

Please provide feedback to @ericholscher_.

.. _@ericholscher: http://twitter.com/ericholscher

Schedule

  • 9-9:30 Introduction to the Tutorial
  • 9:30-9:50 :doc:start
  • 9:50-10:20 :doc:step-1
  • 10:20-10:40 Break
  • 10:40-11:10 :doc:step-2
  • 11:10-11:40 :doc:step-3
  • 11:40-12:20 :doc:finish

Thanks for coming

.. toctree:: :maxdepth: 2 :caption: Tutorial

start step-1 step-2 step-3 finish

.. toctree:: :maxdepth: 2 :caption: Supplemental Material

cheatsheet

.. toctree:: :caption: Step 1 :glob:

crawler/docs/step1/index

.. toctree:: :caption: Step 2 :glob:

crawler/docs/step2/index

.. toctree:: :caption: Step 3 :glob:

crawler/docs/step3/index