[7.x] Document all APIs, add stability warning

This commit is contained in:
Seth Michael Larson
2020-10-28 13:49:05 -05:00
committed by GitHub
parent c1fbdef75e
commit d08860a357
24 changed files with 696 additions and 253 deletions
+2
View File
@@ -168,6 +168,8 @@ class API:
self._def = definition
self.description = ""
self.doc_url = ""
self.stability = self._def.get("stability", "stable")
if isinstance(definition["documentation"], str):
self.doc_url = definition["documentation"]
else:
+7
View File
@@ -9,6 +9,13 @@
`<{{ api.doc_url }}>`_
{% endif %}
{% if api.stability != "stable" %}
.. warning::
This API is **{{ api.stability }}** so may include breaking changes
or be removed in a future version
{% endif %}
{% if api.params|list|length %}
{% for p, info in api.params %}