Skip to content

Commit cb89535

Browse files
committed
Reference code API docs
1 parent 9762b79 commit cb89535

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

docs/api/index.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
API Reference
2+
=============
3+
4+
Documentation with information of functions, classes or methods and all other parts of the OpenAPI-core public API.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
openapi

docs/api/openapi.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
`OpenAPI` class
2+
===============
3+
4+
.. autoclass:: openapi_core.OpenAPI
5+
:members:

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ openapi-core
1111
customizations/index
1212
security
1313
extensions
14+
api/index
1415
contributing
1516

1617
Openapi-core is a Python library that adds client-side and server-side support

openapi_core/app.py

+8-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,14 @@
7171

7272

7373
class OpenAPI:
74-
"""OpenAPI class."""
74+
"""`OpenAPI` application class, the main entrypoint class for OpenAPI-core.
75+
76+
Import :class:`OpenAPI` class from the main :module:`openapi_core` module::
77+
78+
from openapi_core import OpenAPI
79+
80+
app = OpenAPI(spec)
81+
"""
7582

7683
def __init__(
7784
self,

0 commit comments

Comments
 (0)