如何用sphinx生成函数签名？

Question

包结构和文件设置如下:

$ 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

在make html生成sphinx文档之后,prepare列出了函数,但没有记录此函数的签名:

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

   .. rubric:: Functions

   .. autosummary::

      prepare

我的问题是如何生成然后,在这种情况下如何自动生成函数签名？

Answer 1

.. automodule:: foo.spam

我认为这是你的问题（如果你还没有解决）

正确的方法不是吗

.. automodule:: spam