Sphinx autodoc functions within module

Question

I am just getting started with sphinx and willing to learn.

I would like to break up my various functions into different sections within my index.rst file. So each function has it's own header.

So for example if I have a python file named test.py and within that file I have 2 functions:

def foo():
    """This prints bar"""
    print("bar")

def bar():
    """This prints foo"""
    print("foo")

How could I within the index.rst separate the 2 functions within my test.py file?

:mod:`test` -- foo
.. automodule:: test.foo
   :members:
   :undoc-members:
   :show-inheritance: 
:mod:`test` -- bar
.. automodule:: test.bar
   :members:
   :undoc-members:
   :show-inheritance:

If I can figure out how to separate the functions so it looks cleaner in the index.html that would be great! As it is now the output is not very clean if I just run the following below:

:mod:`test` -- these are my functions
--------------------------------------------
.. automodule:: test
   :members:
   :undoc-members:
   :show-inheritance:

score 17 · Answer 1 · answered Oct 09 '13 at 19:33

17

You can use autofunction. Like this:

The test module
===============

The test module contains...

.. currentmodule:: test

The foo function
----------------

.. autofunction:: foo

The bar function
----------------

.. autofunction:: bar

answered Oct 09 '13 at 19:33

mzjn

48,958
13
128
248

Is there a way to do it automatically? instead of listing each function? So it lists all the functions that have a docstring? like `.. automodule::` does? – Amir Heshmati Jul 18 '22 at 08:23
2

There is no built-in way to do it. – mzjn Jul 18 '22 at 08:24

Sphinx autodoc functions within module

1 Answers1

Linked