我写了一个python包,在我的课上,我添加了一些关于类和类中方法的文档。
我的包文件夹树是:
.
├── setup.py
├── package name
| ├── __init__.py
| └── some_class.py
我的文档格式是:
""" Package class name
Parameters
----------
params : string
this is params
Attributes
----------
attribute : string
this is attribute
Examples
--------
>>> do something
"""
如何将这些文档导出为HTML文件?
我尝试使用sphinx-quickstart
并且它只创建页面而没有接受类或类的文档