使用sphinx将python包文档导出到html

时间:2018-06-13 15:32:34

标签: python python-sphinx

我写了一个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并且它只创建页面而没有接受类或类的文档

0 个答案:

没有答案