Есть ли способ скрыть autodo c исключений и сохранить методы? - PullRequest
0 голосов
/ 28 апреля 2020

Я документирую огромный Django проект и хотел бы иметь возможность скрыть автоматически сгенерированные Django вещи, как показано ниже. Это то, с чем мне приходится «иметь дело» или есть настройка, которую я еще не нашел?

Я документирую с:

.. automodule:: module.models
    :members:

и получаю такие вещи, как ниже, что будет хорошо, если бы они были переопределены, но это не так:

exception DoesNotExist

exception MultipleObjectsReturned

save(*args, **kwargs):...

1 Ответ

1 голос
/ 28 апреля 2020

См. Документацию директивы automodule и ее параметров, включая exclude-members:

В директивах, поддерживающих документацию об элементах, также имеется опция exclude-members, которую можно использовать исключить имена отдельных членов из документации, если все члены должны быть задокументированы.

...