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 Getting Started: Overview & Introduction to Concepts
- 2:30-3 Step 1: Getting started with RST
- 3-3:30 Break
- 3:30-4 Step 2: Building References & API docs
- 4-4:30 Step 3: Keeping Documentation Up to Date
- 4:30-5 Finishing Up: Additional Extensions & Individual Exploration
Tutorial¶
Supplemental Material¶
Step 2¶