狮身人面像不是autodocumenting装饰芹菜的任务

时间:2015-10-29 13:59:17

标签: python celery python-sphinx

我正在尝试运行Sphinx来记录以下Celery任务,但是在生成Sphinx文档时我得到一个空文档:

@celery.task(name='taskname')
def taskname(data):
    """
    Some documentation

    """
    ...

......而以下文件记录正确:

def non_decorated_function(data):
    """
    Some documentation

    """
    ...

我知道celery任务装饰器会破坏函数签名,但我认为conf.py中的以下内容应该可以解决这个问题:

extensions = [
    'sphinx.ext.autodoc',
    'celery.contrib.sphinx',
]

我的.rst文件如下所示:

.. automodule:: tasks
    :members:
    :undoc-members:
    :show-inheritance:

使用autotask 可以工作,但我希望能够使用自动模块,因为我将其添加到一个重要的代码库中:

.. automodule:: tasks
    :members:
    :undoc-members:
    :show-inheritance:
.. autotask:: tasks.taskname

有什么方法可以修复Sphinx文档支持的芹菜任务装饰器吗?

1 个答案:

答案 0 :(得分:0)

查看官方文档here

您似乎需要在'celery.contrib.sphinx'文件中docs/conf.py