Запитання з тегом «autodoc»

Я намагаюся використовувати Sphinx для документування 5000-лінійного проекту в Python. Він має близько 7 базових модулів. Наскільки я знаю, для використання autodoc мені потрібно написати такий код для кожного файлу в моєму проекті: .. automodule:: mods.set.tests :members: :show-inheritance: Це занадто нудно, тому що у мене багато файлів. Було б набагато …

149 python  python-sphinx  autodoc 

Сфінкс за замовчуванням не генерує документи для __init __ (self). Я спробував таке: .. automodule:: mymodule :members: і ..autoclass:: MyClass :members: У Conf.py, встановивши наведене нижче, додає лише докстринг __init __ (self) до класу docstring (документація на autodoc Sphinx, схоже, погоджується, що це очікувана поведінка, але нічого не згадує щодо …

107 python  python-sphinx  autodoc 

Я намагаюся розпочати роботу зі Сфінксом і, здається, маю невблаганні проблеми. Команда: docs/sphinx-quickstart Я відповідаю на всі запитання і все працює добре. Команда: docs/ls Все виглядає нормально. Результат:build Makefile source Команда: sphinx-build -d build/doctrees source build/html Здається, працює. Мені вдалося відкрити файл index.html і побачити "оболонку" того, чого я хочу. …

104 python  python-sphinx  autodoc 

Я використовую сфінкс та плагін autodoc для створення документації API для моїх модулів Python. Хоча я бачу, як добре документувати конкретні параметри, я не можу знайти приклад того, як документувати **kwargsпараметр. Хтось має хороший приклад чіткого способу їх документувати?

99 python  python-sphinx  autodoc