Docs integrations restructure

python-openapi · Nov 22, 2023 · 32720ce · 32720ce
1 parent 88c78dc
commit 32720ce
Show file tree

Hide file tree

Showing 15 changed files with 526 additions and 516 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,5 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    'sphinx.ext.autosummary',
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.coverage",

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,15 +3,16 @@ openapi-core
 
 .. toctree::
     :hidden:
-    :maxdepth: 2
+    :maxdepth: 3
 
     unmarshalling
     validation
-    integrations
+    integrations/index
     customizations
     security
     extensions
     contributing
+    api
 
 Openapi-core is a Python library that adds client-side and server-side support
 for the `OpenAPI v3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md>`__
@@ -21,7 +22,7 @@ Key features
 ------------
 
 * :doc:`validation` and :doc:`unmarshalling <unmarshalling>` of request and response data (including webhooks)
-* :doc:`Integrations <integrations>` with popular libraries (Requests, Werkzeug) and frameworks (Django, Falcon, Flask, Starlette)
+* :doc:`Integrations <integrations/index>` with popular libraries (Requests, Werkzeug) and frameworks (Django, Falcon, Flask, Starlette)
 * :doc:`Customization <customizations>` with **media type deserializers** and **format unmarshallers**
 * :doc:`Security <security>` data providers (API keys, Cookie, Basic and Bearer HTTP authentications)
 
@@ -74,7 +75,7 @@ Retrieve validated and unmarshalled request data
     # get security data
     security = result.security
 
-Request object should implement OpenAPI Request protocol. Check :doc:`integrations` to find oficially supported implementations.
+Request object should implement OpenAPI Request protocol. Check :doc:`integrations/index` to find oficially supported implementations.
 
 For more details read about :doc:`unmarshalling` process.