Real Programmers Write Docs

Ned Batchelder ned at nedbatchelder.com
Wed Sep 27 19:15:17 EDT 2017


On 9/27/17 6:55 PM, Rob Gaddi wrote:
> Anyone have any good references on using Sphinx to generate a mix of 
> autogenerated API docs and hand-written "Yeah, but this is what you DO 
> with it" docs?  Free is good but I'm happy to drop money on books if 
> they're worthwhile.
>

I can offer you an example: the coverage.py docs are in Sphinx, and use 
both auto-generated and hand-written pages: 
https://github.com/nedbat/coveragepy/tree/master/doc   I'm not sure what 
information you are looking for, maybe this will help?

--Ned.



More information about the Python-list mailing list