Tag Archive for 'documentation'

Use Sphinx for documentation

Update: After some folks requested it in the comments, I wrote another post, A minimal Sphinx setup for autodocumenting Python modules. You might want to check this out if you’re specifically interested in automatically documenting your code with Sphinx.

I’ve been doing quite a bit of code documentation lately, and I decided to try and figure out the best tool to use. I found it. It’s called Sphinx, and you can see what the documentation looks like by checking out the documentation for Python itself (v. 2.6 and 3.0).
Here’s how to get started using Sphinx. Continue reading ‘Use Sphinx for documentation’