1
0
Fork 0
satnogs-db/docs
Corey Shields 5e03f7c759 Epic API (doc) changes for SatNOGS DB
I've decided to change things up in API schema and doc generation.

Work is not quite complete but its enough for testing in dev and feedback.

Major changes:
* Renaming of api.view classes to match ViewSet inheritance (minor annoyance)
* Introduce drf-spectacular for schema generation and doc UI via swagger-ui
* lots of doc changes for the API to provide a good experience with the above.

New schema generation should work seamlessly in gitlab ci, as well as via /api/schema dynamically.

The new swagger ui view is available via /api/schema/docs/

Signed-off-by: Corey Shields <cshields@gmail.com>
2021-01-09 20:44:19 -05:00
..
_static Compile docs and publish them as GitLab pages 2019-04-22 14:07:51 +03:00
Makefile docs: Simplify Sphinx configuration 2020-12-29 13:13:57 +02:00
api.rst Epic API (doc) changes for SatNOGS DB 2021-01-09 20:44:19 -05:00
conf.py docs: Simplify Sphinx configuration 2020-12-29 13:13:57 +02:00
developer-guide.rst docs: Add documentation on local docs generation 2019-07-11 10:26:51 +00:00
index.rst Drop 'dev' branch and switch to tagging for releasing 2019-03-16 16:07:29 +02:00
installation-docker.rst docs/installation-*: Add frontend dependencies installation step 2019-04-28 22:41:08 +02:00
installation-virtualenv.rst docs/installation-*: Add frontend dependencies installation step 2019-04-28 22:41:08 +02:00
installation.rst Move doc files inside repo 2017-03-13 19:15:06 +02:00
maintenance.rst docs: Fix formatting 2019-04-27 00:25:30 +03:00
releasing.rst Drop 'dev' branch and switch to tagging for releasing 2019-03-16 16:07:29 +02:00
requirements.txt docs: Add requirements file 2020-12-29 17:17:39 +02:00
setup.cfg docs: Properly set version and release 2020-09-21 17:43:00 +03:00
versioneer.py docs: Properly set version and release 2020-09-21 17:43:00 +03:00