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

Для редактирования документации используется пакет mkdocs, который позволяет писать документацию в том же репозитории, что и основной код.

Вся документация лежит в markdown-файлах внутри директории docs/ проекта. Туда можно свободно создавать файлы, делать ссылки на другие страницы, вставлять картинки, сниппеты кода и всё прочее, что поддерживает markdown. Синтаксис markdown очень простой, посмотреть его можно на любой из страниц этой документации или вот тут: https://www.markdownguide.org/basic-syntax/.

Создание новой страницы

1. Создать в директории docs/ файл.
2. Написать в нём нужный текст.
3. В файл mkdocs.yml в секцию nav добавить ссылку на новую страницу образом, аналогичным уже существующим в этой секции ссылкам.
4. Полюбоваться на свою документацию командой make docs. Она соберёт документацию, посмотреть её в браузере можно будет по ссылке http://localhost:8080/db-app/.