Max*_*Noe 5 python python-sphinx
假设我有以下结构
mypackage
__init__.py
core.py
Run Code Online (Sandbox Code Playgroud)
与__init__.py:
from .core import my_function
__all__ = ['my_function']
Run Code Online (Sandbox Code Playgroud)
和 core.py
def myfunction():
''' really cool function '''
pass
Run Code Online (Sandbox Code Playgroud)
运行sphinx-apidoc --full -o docs,python setup.py build_sphinx
我得到myfunction两次的文档。
如何避免这种重复,最好仅在顶层使用文档(因为这是针对用户的API)。
| 归档时间: |
|
| 查看次数: |
161 次 |
| 最近记录: |