[英]How to use Sphinx apidoc to only document Python classes that are imported in __init__.py?
[英]How to configure Sphinx autodoc to document classes in __init__.py?
我有 Python 代码和 NumPy 文档字符串。 设法将 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'
我还写了一个 function 以确保sys.path
append 所有必需的依赖项。
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 以缩小差距的见解。
下面的sys.path
适用于所有子包/模块,除了只有__init__.py
文件的模块。 我使用../..
因为conf.py
是顶级 python 源文件文件夹下面的 2 个层次结构。
sys.path.insert(0, os.path.abspath('../..'))
通过明确 append ../../packages/pss/src/dd
到sys.path
已经解决了基于问题定义示例的只有__init__.py
文件的模块的问题。
sys.path.insert(0, os.path.abspath('../../packages/pss/src/dd'))
显然,必须解决所有报告的警告才能使文档按预期呈现。
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
面临同样的问题。 Python 3.6 和狮身人面像 1.8.0。 它根本没有拾取 python 文件存在于还包含init .py(empty) 文件的目录中。 路径和一切都设置正确。 你找到任何解决方案了吗?
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.