Я пытаюсь использовать Sphinx для документирования проекта на 5000 строк в Python. Имеет около 7 базовых модулей. Насколько я знаю, чтобы использовать autodoc, мне нужно написать такой код для каждого файла в моем проекте: .. automodule:: mods.set.tests :members: :show-inheritance: Это слишком...
По умолчанию Sphinx не создает документы для __init __ (self). Я пробовал следующее: .. automodule:: mymodule :members: и ..autoclass:: MyClass :members: В conf.py установка следующего только добавляет строку документации __init __ (self) в строку документации класса ( документация Sphinx autodoc,...
Я пытаюсь начать работать со Sphinx, но у меня постоянные проблемы. Команда: docs/sphinx-quickstart Отвечаю на все вопросы и все работает нормально. Команда: docs/ls Все нормально выглядит. Результат:build Makefile source Команда: sphinx-build -d build/doctrees source build/html Вроде работает....
Я использую sphinx и плагин autodoc для создания документации API для моих модулей Python. Хотя я вижу, как красиво документировать определенные параметры, я не могу найти пример того, как документировать **kwargsпараметр. Есть ли у кого-нибудь хороший пример четкого способа их документировать?...