Я только начал использовать инструмент Sphinx для создания документации для моего кода. Но я немного смущен, потому что это не так просто, как я ожидал. Я создаю документ Sphinx, используя:
а затем я создаю файлы *.rst в папке «source». Похоже, мне нужно создать файл *.rst для каждого модуля, для которого я хочу создать документ. Для test.py я создаю test.rst. Внутри test.rst у меня есть:
Код: Выделить всё
.. automodule:: test
:members:
:show-inheritance:
Затем внутри test.py у меня есть:
Код: Выделить всё
"""
.. module:: test
:platform: Unix, Windows
:synopsis: A useful module indeed.
"""
Затем я создаю документацию, используя:
Все работает так, как ожидалось, но проблема в том, что это не так просто, как я ожидал. Я предполагаю, что должен быть более простой способ сделать это, пропустив некоторые из этих шагов. Интересно, есть ли какой-нибудь способ создать документацию для всех модулей внутри пакета вместо создания файла *.rst для каждого модуля.
Спасибо.
Подробнее здесь:
https://stackoverflow.com/questions/610 ... -practices
Мобильная версия