fb4a514693
Bump 'versioneer' version
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2022-07-15 14:42:53 +03:00
a8370bb06b
docs: Remove link to broken Python API client
...
The API client is undocumented[1] and effectively broken.
A similar issue exists in satnogs-network[2].
Remove links to the Python API client until it was figured out how to use it.
[1]: https://gitlab.com/librespacefoundation/satnogs/satnogs-db/-/issues/509
[2]: https://gitlab.com/librespacefoundation/satnogs/satnogs-network/-/issues/824
Signed-off-by: Fabian P. Schmidt <kerel@mailbox.org>
2022-02-16 12:04:48 +01:00
98acbd2640
tox: Bump 'twine' and 'sphinx_rtd_theme' versions
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2021-01-14 15:28:20 +02:00
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
18ff90735e
docs: Add requirements file
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-12-29 17:17:39 +02:00
cc422353e7
docs: Simplify Sphinx configuration
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-12-29 13:13:57 +02:00
b51e6f4792
docs: Properly set version and release
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-09-21 17:43:00 +03:00
498fa704a3
docs: Point to generated API documentation
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-09-21 17:41:05 +03:00
e2086c72b8
satnogs-db-api-client: Generate API documentation
...
Generate API documentation from OpenAPI specification. Also, update
outdated Sphinx documentation and include the generated docs.
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-09-21 13:13:10 +03:00
118cb7cadc
Remove python 2 compatibility code
...
Signed-off-by: Alfredos-Panagiotis Damkalis <fredy@fredy.gr>
2020-07-13 13:32:45 +03:00
203f9a7258
docs: Add documentation on local docs generation
...
Signed-off-by: Fabian P. Schmidt <kerel@mailbox.org>
2019-07-11 10:26:51 +00:00
d4fb5189d1
future imports and remove unicode strings
...
adds from __future__ import unicode_literals, absolute_import, division, print_function to all files, removes unicode strings from RTD conf.py (none other were found in our codebase)
See also https://docs.djangoproject.com/en/1.11/topics/python3/#unicode-literals
fixes #290
tested locally in docker
2019-06-30 19:23:55 -04:00
f141ce2580
docs/installation-*: Add frontend dependencies installation step
...
Signed-off-by: Fabian P. Schmidt <kerel-fs@gmx.de>
2019-04-28 22:41:08 +02:00
a8993036d1
docs: Fix formatting
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-04-27 00:25:30 +03:00
1ebedf7f90
Switch to 'npm' for managing dependencies, remove static assets
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-04-27 00:23:33 +03:00
448b48e61c
Use Read the Docs theme
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-04-22 14:07:51 +03:00
28a7111a1f
Compile docs and publish them as GitLab pages
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-04-22 14:07:51 +03:00
c5d321dd8b
Drop 'dev' branch and switch to tagging for releasing
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-03-16 16:07:29 +02:00
e870527d64
docs: Fix copyright notice
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-03-14 22:51:36 +02:00
f5be1d784e
docs: Fix references on documents
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-03-14 22:49:43 +02:00
6f7e38b888
docs: Fix name of transmitters API referenced document
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-03-14 22:47:05 +02:00
2a84aacbe7
Update contribution and developing guides
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-03-06 00:09:17 +02:00
e4cadb93d5
Update documentation to mention refreshing of 'requirements-dev.txt' file
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-01-07 18:13:42 +02:00
b0299e39eb
Add utility for refreshing requirements file
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2019-01-03 00:05:20 +02:00
d76c399d24
Use 'djangoctl.sh' or production image to run application
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2018-11-12 12:43:36 +02:00
af7a1dd6d5
docs: Add maintenance guide
2018-11-07 13:54:37 +01:00
6832b45068
Move requirement files to top directory
...
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2018-11-06 14:00:07 +02:00
2ce456ad09
Update docs for gitlab
2017-10-02 15:55:43 +03:00
bae488a7ea
Update configuration for Gitlab transition
...
* Add CI config
* Update README
* Remove Changelog (moving to CD)
* Split docker to dev and test
2017-09-08 18:42:21 +03:00
3704e8388d
Add Sphinx config
2017-03-13 19:41:58 +02:00
9c5cde23a2
Move doc files inside repo
2017-03-13 19:15:06 +02:00
Vasilis Tsiligiannis