Core2 Docs

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

Online просмотр

Установка MkDocs

1. Перейдите на страницу приложения и выполните указанные действия для установки базовой версии. MkDocs Installation
2. Установите несколько плагинов требуемых для сборки Внешний вид Material for MkDocs

$ pip install mkdocs-material

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

$ pip install mkdocs-glightbox

Подробнее

Запуск и сборка сайта документации

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

$  python -m mkdocs serve

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

$  python -m mkdocs build 

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

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