ГЕНЕРАЦИЯ ДОКУМЕНТАЦИИ

Настройка проекта
Проект документации придерживается определенной структуры размещения документов. Вам следует изучить и соблюдать эти правила.
Проведем первые шаги настройки проекта и генерацию документации.
Не забывайте настроить виртуальную среду для разработки.

Введите в терминале команду установки
>>> python -m pip install sphinx

После установки проверьте ее наличие
sphinx-build --version
Команда создания макета документации
>>> sphinx-quickstart docs
описание шагов
Появятся ряд вопросов, необходимых для создания основного каталога и макета конфигурации для вашего проекта внутри папки docs. Укажите необходимые ответы (в дальнейшем их можно поправить):

> Separate source and build directories (y/n) [n]: Напишите «y» (без кавычек) и нажмите Enter.

> Project name: Напишите название вашего проекта.

> Author name(s): Напишите автора или компанию документации.

> Project release []: Напишите версию документации.

> Project language [en]: оставьте поле пустым (по умолчанию, английский язык) или укажите язык.
Структура каталога документации
docs
├── build
├── make.bat
├── Makefile
└── source
   ├── conf.py
   ├── index.rst
   ├── _static
   └── _templates
Назначение файлов и каталогов
build/ Пустой каталог (на данный момент), в котором будет храниться сгенерированная документация.
make.bat файл выполнения сценариев для упрощения некоторых распространенных операций Sphinx, таких как рендеринг контента.
source/conf.py конфигурация проекта Sphinx.
source/index.rst Корневой документ проекта, "точка входа"
_static папка для хранения статических файлов
_templates папка для хранения файлов шаблона документации
Команда генерации документации
>>> cd docs
>>> make html
генерация в другие форматы
Вы можете сгенерировать и другие форматы документации, использовав команды

>>> make pdf
>>> make epub
Пример документации
Для тренировки навыка работы с документацией Вы можете рассмотреть и клонировать мой проект документации по MicroPython. Откройте репозиторий и ознакомьтесь со структурой файлов. Перейти
Если Вас заинтересовал проект или возникли сложности ознакомьтесь с официальной документацией проекта

https://www.sphinx-doc.org/

Также Вы можете связаться со мной и задать вопрос
Координаты для связи указаны в категории "Об авторе"