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导入Y的所有类或函数都没有自动进行文档编辑。 __init__.py
中直接收集的所有内容都不会被导入。我尝试显式导入每个对象,但无法解决任何问题。
答案 0 :(得分:0)
事实证明,使用import-members可以做到这一点,但同时也会拖入所有std-lib和第三方导入,使您的狮身人面像文档变得混乱。