Я только начал использовать инструмент Sphinx для создания документации для своего кода. Но я немного сбит с толку, потому что это не так просто, как я ожидал. Я создаю документ Sphinx, используя:
sphinx-quickstart
, а затем создаю свои файлы * .rst в "исходной" папке. Похоже, мне нужно создать файл * .rst для каждого модуля, для которого я хочу создать документ. Для test.py я создаю test.rst. Внутри test.rst у меня есть:
.. automodule:: test
:members:
:show-inheritance:
Затем внутри test.py у меня есть:
"""
.. module:: test
:platform: Unix, Windows
:synopsis: A useful module indeed.
"""
Затем я генерирую документацию, используя:
sphinx-build -b html source/ build/
Все работает, как ожидалось, но проблема в том, что это не так просто, как я ожидал. Я предполагаю, что должен быть более простой способ сделать это, пропустив некоторые из этих шагов. Интересно, есть ли способ создать документацию для всех модулей внутри пакета вместо создания файла * .rst для каждого модуля.
Спасибо.