Auto Python Doc

(Note: copy of my original blog post from September 2016)
I recently went through the pain of configuring a Python project to automatically produce documentation on Read the Docs. While the outcome was good, the process getting there wasn’t… This blog is for those who want to avoid the steep learning curve I went through.

To help others, I’ve created an example Python project on GitHub that auto generates Read the Docs documentation (here) about documenting  Python projects on GitHub… Nicely circular huh?

What’s really useful is the documentation on Read the Docs can be referenced back against the code on GitHub that has produced it.

I’ve probably missed a whole heap of useful tips, so leave a comment if you have good advice on this topic to share.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s