Commit Graph

28 Commits

Author SHA1 Message Date
Min RK
468aa5e93c render openapi spec client-side
- move spec to _static/rest-api.yml, since the original yaml must be served
- copy javascript rendering code from FastAPI (uses swagger-ui)
- remove link to pet store, since there isn't a big enough difference to duplicate it
- remove bootprint rendering with node
2021-10-29 13:13:41 +02:00
Min RK
63a61bcc2f prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working
2021-05-11 10:40:04 +02:00
Chris Holdgraf
676a0da5ff fixing links 2019-11-21 08:04:20 -08:00
Min RK
35d888e91e make sure new spawner methods are documented 2019-02-27 16:47:46 +01:00
Min RK
5e60582ef3 run autoformat
apologies to anyone finding this commit via git blame or log

run the autoformatting by

    pre-commit run --all-files
2019-02-19 17:00:10 +01:00
Kyla Harper
a78655c5a7 Add DummyAuthenticator documentation 2018-09-27 11:42:06 -05:00
Min RK
8831573b6c typos in services.auth headings 2017-10-03 12:42:52 +02:00
Min RK
a9c0a46a06 add missing classes to services.auth 2017-08-17 17:29:45 +02:00
Carol Willing
68e02dd62a Correct links 2017-08-10 09:07:38 -07:00
Carol Willing
85a75b637a Add automodule for app 2017-08-08 23:07:28 -07:00
Carol Willing
ac13140083 Edit some classes 2017-08-08 23:02:12 -07:00
Carol Willing
024fd07ec8 Update autodoc doc files 2017-08-08 23:01:08 -07:00
Carol Willing
95175155d4 Update autodoc of services.auth and add services 2017-08-08 22:51:35 -07:00
Carol Willing
b77c8a8717 Update the API index section 2017-07-27 19:44:59 -07:00
Min RK
8f49412438 docstrings for proxy 2017-06-26 11:32:15 +02:00
Min RK
08e8c93b16 add app.rst 2017-02-20 21:44:02 +01:00
Min RK
4b987dd334 add configurable traits to api docs 2017-02-13 14:18:20 +01:00
Carol Willing
541997371c Fix broken or changed links 2016-11-12 17:17:00 -08:00
Carol Willing
74f086629c Update API docs 2016-09-19 08:42:28 -07:00
Min RK
b8f4803ef4 Deprecate %U username substitution
use Python format-strings instead.
2016-09-15 12:05:46 +02:00
Carol Willing
f6517d01db Move 'Using API' to user guide 2016-08-18 04:51:48 -07:00
Carol Willing
eba4b3e8c7 More doc edits 2016-08-17 15:11:17 -07:00
Carol Willing
e299a6c279 Remove link and reflow text 2016-07-25 07:41:28 -07:00
Carol Willing
a3e8bd346f Merge pull request #656 from minrk/rest-api-docs
Add REST API to docs
2016-07-25 07:09:16 -07:00
Carol Willing
7d8895c2fb Add links to swagger docs for REST API 2016-07-23 18:47:23 -07:00
Min RK
19ae38c108 add REST API to docs
include local build, even though it's not as nice as petstore.
Due the that, link to petstore as well.
2016-07-23 12:05:25 +02:00
Min RK
9e9c6f2761 document services.auth 2016-05-30 13:32:10 +02:00
Min RK
eb0a38c136 add preliminary API docs 2016-01-20 15:36:24 +01:00