Documenting module/class/function bodies in Python Sphinx docs

Question

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:

Florian Diesch · Accepted Answer · 2010-04-29 06:39:57Z

2

If this still matters: The viewcode extension can do this, but needs the development version (1.0) of Sphinx

answered Apr 29, 2010 at 6:39

Florian Diesch

1,03510 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Patrick Altman · Accepted Answer · 2009-12-03 04:27:33Z

1

I don't believe so. Autodoc is only for pulling the documentation out of the source code.

answered Dec 3, 2009 at 4:27

Patrick Altman

9108 silver badges10 bronze badges

Collectives™ on Stack Overflow

Documenting module/class/function bodies in Python Sphinx docs

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related