使用狮身人面像自动文档Python类，模块(Using sphinx to auto-documen

我已经安装了狮身人面像 ，以记录一些Python模块和类我的工作。 虽然标记语言看起来很不错，我没有设法自动文档Python代码。

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

SegLib.py

和一类称为Seg在里面。 我想显示所生成的斯芬克斯文档内的类和模块的文档字符串，并且进一步格式化文本添加到它。

我index.rst看起来是这样的：

Contents:

.. toctree::
:maxdepth: 2

chapter1.rst

和chapter1.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到段，并chapter1.rst改为（感谢，iElectric！）：本：MOD： segments模块------------------------ -

.. automodule:: segments.segments

.. autoclass:: segments.segments.Seg

不过，不能得到狮身人面像一个类中直接记录功能，或更好 - 一类中自动添加的所有功能的文档。 试着

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

并得到了：

autodoc can't import/find function 'segments.segments.Seg.sid', it reported error: "No module named Seg"

任何想法如何用简短的命令autodocument函数和类？

乌迪

Answer 1:

添加到该文件的开头：

.. module:: SegLib

尝试使用：AUTOCLASS：指令类的文档。

BTW：模块名称应该LOWER_CASE。

编辑： 我学到了很多从阅读其他的源文件 。

文章来源: Using sphinx to auto-document a python class, module