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

时间:2016-01-10 21:44:03

标签: python python-sphinx

我有一个使用Sphinx记录的Python包。我的模块包含Python docstrings中的大部分文档。

现在,我的结果文档如下:

command_1()
  blah
  blah
  blah
  blah
  blah

command_2()
  blah
  blah
  blah
  blah
  blah

我还希望得到一个自动创建的表,在模块/子模块中创建一个快速的命令表。像:

command_1 blah
command_2 blah

有没有办法自动执行此操作?

(正如有人提到的,有一个autosummary extention。据我所知,这并不能完全符合我的要求。自动扩展扩展可以创建文档存根,也可以汇总文档。但是你必须手动输入您想要汇总的每个命令。或者我只是不知道如何使用它。)

0 个答案:

没有答案