Modern Python Projects Transcripts
Chapter: Documentation
Lecture: Sphinx

Login or purchase this course to watch this video and the rest of the course contents.
0:00 In this chapter, we are going to write and display documentation for our code.
0:04 One of the most popular tools for managing documentation in Python is called Sphinx.
0:09 It's easy to use and comes with a lot of useful features out of the box
0:13 You can, for example,
0:15 generate documentation in different formats like HTML, LaTeX,
0:19 epub, plain text and so on,
0:21 and with LaTeX, you can easily generate the PDF files.
0:25 You can easily create hyperlinks between different functions and modules in your project.
0:30 You can automatically generate documentation for your API directly from the dock strings,
0:36 and you can test code examples in the documentation,
0:38 just like we did with pytest.