HyperLEDA / db-app

Backend for HyperLeda astronomical database of extragalactic objects
https://hyperleda.github.io/db-app/
MIT License
0 stars 0 forks source link

Генерировать документацию из python-кода и схемы API #98

Open Kraysent opened 2 months ago

Kraysent commented 2 months ago

В рамках #93 перенесли документацию на gh-pages, теперь хочется во время генерации документации автоматически генерировать страницы с python-комментариями и картинку со схемой БД.

Генерация доки из комментариев: https://stackoverflow.com/a/59128670/14653527 Плагин для mkdocs который позволяет вставлять в навигацию страницы, не перечисленные явным образом в конфиге: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin Генерация диаграммы связей в бд: https://github.com/cbbrowne/autodoc

Kraysent commented 2 months ago

Помимо всего прочего можно и описание API туда же сгенерировать - https://github.com/bharel/mkdocs-render-swagger-plugin Запустить сервер, дернуть метод со сваггером, получить json, сохранить его на диск и из него сгенерировать документацию, выглядит как будто не очень сложно.

Kraysent commented 2 months ago

Сделал swagger-документацию в рамках #125