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, or open an issue on GitHub.

Schedule

• 1:30-2 Introduction to the Tutorial
• 2-2:30 :doc:`start`
• 2:30-3 :doc:`step-1`
• 3-3:30 Break
• 3:30-4 :doc:`step-2`
• 4-4:30 :doc:`step-3`
• 4:30-5 :doc:`finish`

.. 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