Reference code API docs

python-openapi · Feb 12, 2024 · cb89535 · cb89535
1 parent 9762b79
commit cb89535
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/docs/api/index.rst 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
@@ -0,0 +1,5 @@
+`OpenAPI` class
+===============
+
+.. autoclass:: openapi_core.OpenAPI
+    :members:
diff --git 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

diff --git a/openapi_core/app.py b/openapi_core/app.py
@@ -71,7 +71,14 @@
 
 
 class OpenAPI:
-    """OpenAPI class."""
+    """`OpenAPI` application class, the main entrypoint class for OpenAPI-core.
+    
+    Import :class:`OpenAPI` class from the main :module:`openapi_core` module::
+
+        from openapi_core import OpenAPI
+
+        app = OpenAPI(spec)
+    """
 
     def __init__(
         self,