diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 00000000..f70b04bc --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,9 @@ +API Reference +============= + +Documentation with information of functions, classes or methods and all other parts of the OpenAPI-core public API. + +.. toctree:: + :maxdepth: 1 + + openapi diff --git a/docs/api/openapi.rst b/docs/api/openapi.rst new file mode 100644 index 00000000..2ed3cd43 --- /dev/null +++ b/docs/api/openapi.rst @@ -0,0 +1,5 @@ +`OpenAPI` class +=============== + +.. autoclass:: openapi_core.OpenAPI + :members: diff --git a/docs/index.rst b/docs/index.rst index 24eacced..b23e8d0a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ openapi-core customizations/index security extensions + api/index contributing Openapi-core is a Python library that adds client-side and server-side support