Documenting Python Projects With Sphinx and Read The Docs

Documenting Python Projects With Sphinx and Read The Docs
Documenting Python Projects With Sphinx and Read The Docs
English | MP4 | AVC 1920×1080 | AAC 48KHz 2ch | 0h 17m | 69 MB

In this video series we’ll cover creating Python documentation from scratch using Sphinx, as well as getting your code repository hooked up to Read The Docs, to automatically build and publish your code documentation.

Table of Contents

1 Python Project Documentation Overview
2 Setting Up a Sphinx Example Project and Scaffolding
3 Updating Your Sphinx Documentation
4 Previewing ReStructuredText (.rst) Files
5 Configuring Sphinx Subheadings With maxdepth
6 Hosting Your Documentation on Read The Docs