О MkDocs

Эта документация построена при помощи документатора MkDocs.

Базовые команды

Чтобы запустить документацию в браузере используя IDE или терминал

mkdocs serve

Пересобрать статический сайт (хранится в папке site). Не требует обращения к терминалу каждый раз, но требует периодической пересборки.

mkdocs build

Обновить документацию на гитхабе (требуется чтобы обновлённые файлы уже были на гитхабе хоть на какой-то ветке).

mkdocs gh-deploy

Задействованные файлы и папки под mkdocs

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.
site/
    ...       # Статический сайт

Дополнительно о mkdocs

Краткая справочная информация по mkdocs

mkdocs -h

Полезная статья со внешнего источника о работе документатора mkdocs:

open https://realpython.com/python-project-documentation-with-mkdocs/

Больше информации - на официальном сайте

open https://www.mkdocs.org

Расширения

В данном проекте используются следующие расширения

mkdocs
mkdocs-material
mkdocstrings
mkdocstrings-python
pymdown-extensions

Всех их можно установить при помощи команды pip install ...

Список необходимых для работы mkdocs расширений можно узнать при помощи команды

cd ..
mkdocs get-deps