Modern Python Projects Transcripts
Chapter: Documentation
Lecture: Read the Docs
Login or
purchase this course
to watch this video and the rest of the course contents.
0:00
Once you finish writing your documentation, you need to figure out where to publish it. If your project is open source,
0:08
then the easiest way to Host your documentation online is to use the website called read the docs It's a free hosting for open source projects,
0:16
and it supports sphinx, out of the box. You'll have to log in and connect your GitHub project.
0:26
But then read The docs will automatically build and publish your documentation each time you update your project on github. As you can see,
0:35
you can sign up directly with GitHub or GitLab or even Bitbucket if you're still using it. And once you publish your documentation,
0:43
this is how it will look like. Here is an example of Read the Dogs Documentation for Request Package.
0:50
It looks very similar to ours sphinx, documentation that we used in the previous lessons because well it is using sphinx.