]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc: silence warnings from openapi sphinx extension 39201/head
authorKefu Chai <kchai@redhat.com>
Mon, 1 Feb 2021 09:53:27 +0000 (17:53 +0800)
committerKefu Chai <kchai@redhat.com>
Mon, 1 Feb 2021 09:57:57 +0000 (17:57 +0800)
commit1debd9856565905439ae56f2cfdc16b0549055ec
tree1335d5b5eeda685428b32ebbc0cdc39ce05ce07f
parent639fac3564737a1a1d8322e29e5c034f73df790b
doc: silence warnings from openapi sphinx extension

it prints out

skipping non-JSON example generation.

if an API does not contains example while ":example:" is specified for
openapi extension, and if this API is not a GET request, openapi
extention complains.

see also
https://github.com/sphinx-contrib/openapi/blob/9dbae9c9a65291c44b27041c63ded1b20611a2fc/sphinxcontrib/openapi/openapi30.py#L191

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/conf.py