[7.x] Document all APIs, add stability warning
This commit is contained in:
@@ -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:
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
Reference in New Issue
Block a user