Документация

Вся документация ведется в файлах формата Markdown. Созданные файлы автоматически собираются в сайт с помощью приложения MkDocs

Установка MkDocs

1) Перейдите на страницу приложения и выполните указанные действия для установки базовой версии. MkDocs Installation

2) Установите несколько плагинов требуемых для сборки

Внешний вид Material for MkDocs

$ pip install mkdocs-material

Плагин для отображения картинок на весь экран.

$ pip install mkdocs-glightbox

Основная информация о всех нюансах настройки расположена на сайте приложения:

Все настройки проекта находятся в файле /mkdocs.yml
Его основные параметры:

site_name - Название проекта
site_url - Страница проекта
repo_name - Название репозитория
repo_url - Страница репозитория
theme - Настройки темы
- name - Имя темы
- features - Список активных функций
- palette - Тонкая настройка внешнего вида сайта (цвета, логотипы и тд.)
extra_javascript - Дополнительные JS скрипты добавленные на страницы
extra_css - Дополнительные CSS скрипты добавленные на страницы
plugins - Активные плагины
markdown_extensions - Дополнительные расширения для парсинга markdown
nav - Самая важная часть - список страниц
- Все указанные в этом разделе пункты должны иметь название и путь до файла .md

Для онлайн просмотра содержимого документации на своем компьютере выполните команду и после этого перейдите на страницу localhost:8000

$  python -m mkdocs serve

Для сборки сайта документации выполните команду

$  python -m mkdocs build

После этого созданный сайт будет помещен в папку /site в корне проекта

Более подробно о командах можно узнать на странице приложения - Command Line Interface