Completed
How to start a Sphinx project
Class Central Classrooms beta
YouTube videos curated by Class Central.
Classroom Contents
Sphinx Autodoc - Automated API Documentation
Automatically move to the next video in the Classroom when playback concludes
- 1 Intro
- 2 What is the reason you do not write docstrings.
- 3 What is Sphinx?
- 4 The history of Sphinx (short ver.)
- 5 Sphinx Before and After
- 6 Sphinx extensions (built-in)
- 7 library code example
- 8 How to install Sphinx
- 9 How to start a Sphinx project
- 10 Current files structure
- 11 setup autodoc extension
- 12 Add automodule directive to your doc
- 13 How does it work?
- 14 Danger code
- 15 execution guard on import
- 16 "info field lists" for arguments
- 17 Code example in a docstring
- 18 Syntax highlighted output
- 19 setup doctest extension
- 20 Result of "make doctest"
- 21 Individual pages for each modules
- 22 setup autosummary extension
- 23 Replace automodule with autosummary
- 24 Output of autosummary
- 25 setup coverage extension
- 26 Why don't you write docstrings?
- 27 Options for autodoc
- 28 SV sphinxcontrib-httpdomain 3rd party ext
- 29 Translation into other languages
