Modern Python Projects Transcripts
Chapter: Course conclusion and review
Lecture: Documentation

Login or purchase this course to watch this video and the rest of the course contents.
0:00 When you are ready to share your python project with the rest of the world,
0:04 you need to find a way to tell others how to use it.
0:07 So you will need to write some documentation.
0:11 And the best way to write documentation in Python is to use the library,
0:14 called Sphinx. Sphinx will generate the documentation from the RST files,
0:19 and then you can display them in either the HTML format,
0:23 in Latex and in a lot of other output formats.
0:26 One of the best features of Sphinx is that it comes with a bunch of plugins
0:30 that makes writing documentation much easier.
0:33 You can automatically extract the doc strings from your code.
0:37 You can add links to the source code,
0:39 and you can even generate the CLI documentation when you are using libraries like Click.
0:44 When you are ready to publish your documentation,
0:47 you can visit the Read the Docs Website and host it there.
0:51 And if you want to use a different tool,
0:53 than Sphinx. There is also MKdocs that works very well and swagger or
0:58 redoc that will automatically generate the documentation for your RestAPI.