Python Sphinx未自动记录装饰芹菜任务
我正试图运行Sphinx来记录以下芹菜任务,但在生成Sphinx文档时得到一个空文档:Python Sphinx未自动记录装饰芹菜任务,python,celery,python-sphinx,Python,Celery,Python Sphinx,我正试图运行Sphinx来记录以下芹菜任务,但在生成Sphinx文档时得到一个空文档: @celery.task(name='taskname') def taskname(data): """ Some documentation """ ... …鉴于以下内容得到了很好的记录: def non_decorated_function(data): """ Some documentation """ ... 我知道芹菜任务
@celery.task(name='taskname')
def taskname(data):
"""
Some documentation
"""
...
…鉴于以下内容得到了很好的记录:
def non_decorated_function(data):
"""
Some documentation
"""
...
我知道芹菜任务装饰程序弄坏了函数签名,但我认为conf.py中的以下内容应该可以解决这个问题:
extensions = [
'sphinx.ext.autodoc',
'celery.contrib.sphinx',
]
我的.rst文件如下所示:
.. automodule:: tasks
:members:
:undoc-members:
:show-inheritance:
使用autotask确实有效,但我希望通过automodule实现这一点,因为我正在将其添加到一个重要的代码库中:
.. automodule:: tasks
:members:
:undoc-members:
:show-inheritance:
.. autotask:: tasks.taskname
有没有办法修复Sphinx文档支持的芹菜任务装饰器?查看官方文档
看起来您需要在
docs/conf.py
文件中'芹菜.contrib.sphinx'
。您需要换行“一些文档”
到“一些文档{enter key here}”
无论换行状态如何,都会发生这种情况;抱歉搞混了!你确定吗?在编辑时请注意,这不是正确的格式<代码>“description{enter}”“autotask
是执行此操作的官方方法,请参见@KobiK,文档中没有说明这一点。“安装扩展后,autodoc将自动查找任务修饰对象…”和“使用..自动任务::手动记录任务。”自动部分(看起来得到官方支持)无法工作。只有手动部分工作。