【发布时间】:2019-07-12 17:26:39
【问题描述】:
Sphinx 似乎忽略了自动文档模块中的导入。
doc/conf.py 摘录
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.setrecursionlimit(1500)
doc/code.rst
Auto Generated Documentation
============================
Utils
-----
.. automodule:: myproject.utils
:members:
myproject/utils/__init__.py
from data import *
from hashing import *
from redis import *
from cookie import *
from route import *
def method_whose_docstring_is_picked_up(string):
"""I'm being autodoc'ed. =)
"""
X import Y 中的所有类或函数都没有被自动文档化。直接在__init__.py 中的任何内容都被拾取,而不是导入。我尝试显式导入每个对象,但没有解决任何问题。
【问题讨论】:
-
添加
__all__列表是否有效?见stackoverflow.com/q/30856279/407651 -
“自动模块的选项未知或具有无效的 id 值:'all'”。好像没有。
-
__all__不是automodule的选项,它是一个可以添加到__init__.py的变量(参见docs.python.org/2/tutorial/…)。