DeemOnSecurity / sphinx-tutorial

An opinionated tutorial on Sphinx.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

Schedule

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


About

An opinionated tutorial on Sphinx.


Languages

Language:Python 53.1%Language:Makefile 46.9%