如何在子模块中创建命令表?

2024-04-19 17:05:49 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个用Sphinx编写的Python包。我的模块有Python docstring中的大部分文档。你知道吗

现在,生成的文档如下所示:

command_1()
  blah
  blah
  blah
  blah
  blah

command_2()
  blah
  blah
  blah
  blah
  blah

我还想得到一个自动创建的表,它在一个模块/子模块中创建一个命令的快速表。比如:

command_1 blah
command_2 blah

有没有办法自动做到这一点?你知道吗

(正如有人提到的,有一个autosummary extention。据我所知,这并不是我想要的。autosummary扩展可以创建文档存根,也可以汇总文档。但是您必须手动键入每个要摘要的命令。或者我就是不知道怎么用。)


Tags: 模块文档命令键入sphinx手动command存根