从我的Django文件中提取所有文档字符串（__doc__）

Question

我在Django中有一个项目，并且在模块，类和函数中编写了文档字符串。但是我需要一种从那里自动提取所有__doc__的方法。类似于“ python manage.py collectstatic”，但适用于所有.__doc__代码的.py个实例。这样的事吗？有想法吗？

Answer 1

让您瞥见pydoc

示例模块：

# foo.py

def bar():
  """this is the docstring for bar()"""
  print 'hello'


def baz():
  """this is the docstring for baz()"""
  print 'world'

现在，您可以使用以下命令打印文档字符串：

$ pydoc foo.py
Help on module foo:

NAME
    foo

FILE
    /path/to/foo.py

FUNCTIONS
    bar()
        this is the docstring for bar()

    baz()
        this is the docstring for baz()

您还可以生成HTML帮助文件：

$ pydoc -w ./foo.py
wrote foo.html

如下所示：