使用sphinx自动记录python类、模块

为了记录我正在使用的一些Python模块和类，我安装了。虽然标记语言看起来很不错，但我还没有成功地自动记录Python代码

基本上，我有以下Python模块：

SegLib.py

其中有一个名为

Seg

的类。我想在生成的Sphinx文档中显示类和模块的docstring，并向其中添加进一步的格式化文本

我的

index.rst

如下所示：

Contents:

.. toctree::
:maxdepth: 2

chapter1.rst

和

第1章rst

：

This is a header
================
Some text, *italic text*, **bold text**

* bulleted list.  There needs to be a space right after the "*"
* item 2

.. note::
   This is a note.

See :class:`Seg`

但是，

Seg

只是以粗体打印，并没有链接到该类的自动生成文档

尝试： 参见：类别：

Seg

模块：mod:'SegLib' 模块：mod:'SegLib.py'

也没用。 有什么好主意或者好的教程链接吗

编辑：将SegLib更改为segments（谢谢，iElectric！），并将chapter1.rst更改为： ：mod:

段

模块 --------------------------

.. automodule:: segments.segments

.. autoclass:: segments.segments.Seg

但是，不能让Sphinx直接记录类中的函数，或者更好——自动将类中的所有函数添加到文档中。尝试：

.. autofunction:: segments.segments.Seg.sid

得到：

你知道如何用短命令自动记录函数和类吗

---

Udi

添加到文件的开头：

.. module:: SegLib

尝试对类文档使用：autoclass:指令

顺便说一下：模块名称应该是小写的

---

首先，在index.rst中编辑：

。当文档变大时，将其拆分为多个文件。

.. module:: SegLib