#python-sphinx #private-members #autodoc
#python-sphinx #частные участники #автоматическая настройка
Вопрос:
Возможно ли изменить порядок вывода, генерируемого с помощью Sphinx AutoDoc?
В частности, я включаю закрытые члены, используя :private-members: директиву. Я хочу, чтобы закрытые элементы отображались последними в выходных данных, а не первыми, что является значением по умолчанию, вызванным алфавитным порядком и символом «_», стоящим перед «A».
Комментарии:
1. Читая документацию, я нашел этот вариант sphinx-doc.org/en/master/usage/extensions/… Это делает то, что вы хотите?
Ответ №1:
Как и упоминал @Steve Piercy, вы можете установить порядок, используя значение конфигурации autodoc_member_order . Чтобы получить желаемое поведение, просто добавьте autodoc_member_order = 'bysource' в свой conf.py . Это сделает порядок вашей документации таким же, как и исходный порядок.
Комментарии:
1. Есть ли способ изменить поведение по модулю за модулем? Или даже по классам?