| Commit message (Collapse) | Author | Age |
|---|
| |
|
|
| |
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| |
|
|
|
|
|
|
| |
This picks up an important fix [1] we want for our docs build.
[1] https://github.com/sphinx-contrib/openapi/pull/87
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| |
|
|
|
|
|
|
|
| |
No changes necessary, thankfully, though there is a feature gap here
that we will need 0.7.0 to close [1] :(
[1] https://github.com/sphinx-contrib/openapi/pull/87
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| | |
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
| |
This takes advantage of the sphinxcontrib-openapi Sphinx extension,
which allows us to embed the REST API documentation into our docs quite
nicely.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
OpenAPI doesn't appear to support versioning natively, suggesting
instead that separate documents are kept. Rather than doing this
manually, let's use a templating tool - Jinja2, in this case - to
generate these document for us from a single master document.
Note that while we can now auto-generate these whenever we need them
(and we tend to avoid storing auto-generated assets in VCS), these
change so rarely that it's easier to just store them. This also means we
can reference the schemas themselves online. We do this in a following
change.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| | |
|
| | |
|
| |
|
|
|
|
| |
This ensures things look the same locally as on readthedocs.org.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
| |
|
|
|
|
|
| |
An initial patch to add reno and create a base directory for release
notes.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
|
|
This is mostly the output of 'sphinx-quickstart' with all non-HTML build
cruft removed and Sphinx minimum version set to 1.5. A tox target is
included and the output of the docs build ignored.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|