Documenting module/class/function bodies in python sphinx docs
Posted
by perrierism
on Stack Overflow
See other posts from Stack Overflow
or by perrierism
Published on 2009-12-02T23:30:58Z
Indexed on
2010/04/29
6:47 UTC
Read the original article
Hit count: 417
Is there a way with Sphinx documentation to output a function or class body (the code itself) with the autodoc feature? I'm using autodoc to much success. In addition to the docstrings getting pulled in to the documentation I want like a link to click for each function where it will show you the source... is that possible?
This is about what most of my documentation looks like now:
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
© Stack Overflow or respective owner
