Порядок вывода Sphinx Autodoc - PullRequest
0 голосов
/ 22 марта 2019

Можно ли изменить порядок вывода, сгенерированного с помощью Sphinx AutoDoc?

В частности, я включаю частных пользователей, используя директиву :private-members:. Я хочу, чтобы приватные члены появлялись последними в выходных данных, а не первыми, что является значением по умолчанию, вызванным алфавитным порядком и символом "_", предшествующим "A".

1 Ответ

0 голосов
/ 25 марта 2019

Так же, как упоминалось @Steve Piercy, вы можете установить порядок, используя значение конфигурации autodoc_member_order.Чтобы получить желаемое поведение, просто добавьте autodoc_member_order = 'bysource' к вашему conf.py.Это приведет к тому, что ваша документация упорядочится так же, как ваш исходный заказ.

...