Wie man Funktionssignaturen mit Sphinx erzeugt?

Question

Die Paketstruktur und Dateien sind wie folgt aufgebaut:

$ tree . 
. 
├── doc 
│   ├── Makefile 
│   ├── README.md 
│   ├── _build 
│   ├── _static 
│   ├── conf.py 
│   ├── foo.rst 
│   ├── index.rst 
│   └── make.bat 
└── foo 
    ├── __init__.py 
    └── spam.py 


$ cat foo/__init__.py 
r''' 
The Foo module 
============== 

.. autosummary:: 
    :toctree: generated 

    spam 
''' 


$ cat foo/spam.py 
r''' 
The Spam Module 
=============== 
''' 

def prepare(a): 
    '''Prepare function. 

    Parameters 
    ---------- 
    a : int 
    ''' 
    print(a) 


$ cat doc/index.rst 
Welcome to foo's documentation! 
===================================== 

API Reference 
------------- 

.. toctree:: 
    :maxdepth: 1 

    foo 


Indices and tables 
================== 

* :ref:`genindex` 
* :ref:`modindex` 
* :ref:`search` 


$ cat doc/foo.rst 
.. automodule:: foo 

Nach make html Sphinx-Dokumentation zu erzeugen, Funktion prepare out aufgeführt ist, aber es gibt keine Unterschrift dieser Funktion dokumentiert:

$ cat generated/foo.spam.rst 
foo.spam 
======== 
.. automodule:: foo.spam 

    .. rubric:: Functions 

    .. autosummary:: 

     prepare 

Meine Frage ist wie man dann generiert, wie kann man in diesem Fall automatisch die Funktionssignatur erzeugen?

Answer 1

.. automodule:: foo.spam 

Ich denke, das ist Ihr Problem (wenn Sie es noch nicht gelöst haben)

Wäre das nicht der richtige Weg sein

.. automodule:: spam