In this lesson, you’ll see what should be included in the documentation of your project. Here are the tools, references, and projects that are mentioned:
- Sphinx
- Epydoc
- Read the Docs
- Doxygen
- MkDocs
- pycco
- Django’s documentation
- Requests’ documentation
- Click’s documentation
- Pandas’ documentation
To continue your learning, you might want to check out the following:
- Documenting Python Projects With Sphinx and Read the Docs
- Document Your Python Code and Projects With ChatGPT
- Build Your Python Project Documentation With MkDocs
Congratulations, you made it to the end of the course! What’s your #1 takeaway or favorite thing you learned? How are you going to put your newfound skills to use? Leave a comment in the discussion section and let us know.
Thomas on Feb. 10, 2020
Thanks for this concise tutorial on documentation. Especially Epytext makes my life as a Java developer a lot easier writing Python documentation. I find this topic dead boring, but this tutorial made it a lot easier to get started:)