我有带有 NumPy 文档字符串的 Python 代码。设法将 Sphinx 用于 API 文档，但是，__init__.py文件中的类未成功记录。
例子：xxx/__init__.py
from __future__ import annotations
import sys
import re
from typing import Iterator, ...
import pyparsing as p
__all__ = ['Xxx']
class XxxData:
"""It is a class XxxData."""
def __init__(self):
self.data = dict()
def get_foo(self, foo) -> str:
"""Get foo bar.
Parameters
----------
foo : str
It is just a string.
Returns
-------
str
It is just a string.
"""
return f'{foo} bar'
class Xxx():
"""It is a class Xxx."""
def __init__(self):
super().__init__()
self._something = 'something'
def parse_bar(self, bar) -> XxxData:
"""Parse bar.
Parameters
----------
bar : str
It is just a string.
Returns
-------
XxxData
It is a return object of XxxData.
"""
print(f'Hello {bar}')
data = XxxData()
return data
样品conf.py：
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc', # Core library for html generation from docstrings
'sphinx.ext.autosummary', # Create neat summary tables
'sphinx.ext.napoleon', # Support for NumPy and Google style docstrings
]
autosummary_generate = True # Turn on sphinx.ext.autosummary
autodoc_default_options = {
'show-inheritance': False,
'members': True,
'member-order': 'bysource',
'special-members': '__init__',
'undoc-members': True,
'exclude-members': '__weakref__'
}
autoclass_content = 'both'
我还编写了一个函数来确保sys.path附加所有必需的依赖项。
docs
|-Makefile
|-build
|-make.bat
|-source
|-_static
|-_templates
|-conf.py
|-index.rst
packages
|-pss
|-src/dd
|-ps
|-xxx
|-__init__.py
sphinx-apidoc下面的命令自动创建了 3 个 rst 文件：source/api/ps.rst, source/api/ps.xxx.rst,source/api/modules.rst
sphinx-apidoc -o source/api/ ../packages/pss/src/dd/ps/ --implicit-namespaces -e -M -P
样品source/api/ps.xxx.rst：
ps.xxx package
==============
.. automodule:: ps.xxx
:members:
:undoc-members:
:show-inheritance:
:private-members:
make html构建成功，但警告如下：
WARNING: autodoc: failed to import module 'xxx' from module 'ps'; the following exception was raised:
No module named 'ps.xxx'; 'ps' is not a package
以空内容呈现的 HMTL 页面。我希望看到__init__.py（上面的示例文件）中记录的文档字符串，但没有发生。
从技术上讲，Sphinx 是否适用于__init__.py文件中的类/方法文档字符串？我应该关注那些在 期间发生的警告make html吗？
感谢任何关于如何配置 Sphinx 以缩小差距的见解。