Sphinx and Read the Docs Tips

I am using Sphinx, in conjunction with the awesome Read the Docs documentation building and hosting service, to document my open source senior project Bemuse.

After fiddling for a couple of days, I have few tips and techniques to share.


This is not a pro tip! I only use this name because the subdomain “tips” is already used. I’m also not a Pythonian; I just found Sphinx to be the right (and superior) tool for the right job. Therefore, my code may not be idiomatic – I mean, Pythonic.


The content lives on GitHub at dtinth/rtfd-protips.

If you have any tips to share, or any fixes or improvements, feel free to send me pull requests.