Извлеките все строки документации (__doc__) из моих файлов Django

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

, который выглядит следующим образом: