如何通过从源代码中提取信息来记录Python包

时间:2019-12-13 12:52:49

标签: python python-3.x documentation python-sphinx autodoc

我需要记录一个Python包。该软件包具有用于类和方法的基本文档字符串,这些类和方法提供诸如描述之类的信息。但是文档需要包含其他信息,例如:

1)必须从类的特定参数中提取的信息。这些类可以从其他类继承,在这种情况下,这些参数必须结合该类和父类的参数值。

2)将共享公共父类的所有类归为一个页面/类别。这些可能不一定位于单个子模块中,并且可以散布在软件包中(不是我接受的最佳设计;但是我正在研究无法重组的现有软件包)。

目的是避免必须手动生成这些文档字符串,而不必从源代码本身中提取这些文档字符串。我过去曾使用过Sphinx和autodoc,后者(我相信)确实会导入模块本身并评估其内容。但是,据我所知,它只是选择了现有的文档字符串。

Sphinx / autodoc或其任何其他扩展程序能否满足我的要求?如果是这样,您能不能指出一个可以观察到的例子。如果没有,我还有什么其他选择?我的备份计划(非常基本)是编写一个Python脚本,该脚本将导入我的包,识别所有类并根据必要的参数构建文档页面。但是我有种感觉,我会在这里重新发明轮子。

0 个答案:

没有答案
相关问题