Advanced Code Documentation Beyond Comments and Docstrings

Use Sphinx and Read the Docs for a user-friendly interface to understand codebase — even for non-technical users

Kay Jan Wong
Towards Data Science
7 min readJan 18, 2022

--

Update: This article is part of a series. Check out Part 2, Part 3!

Documentation using Sphinx hosted on Read the Docs — Image by author
Documentation using Sphinx hosted on Read the Docs — Image by author

Documentation shows users how to use or understand a project, and there are different…

--

--

Data Scientist, Machine Learning Engineer, Software Developer, Programmer | Someone who loves coding, and believes coding should make our lives easier