Update quickstart documentation

connexion/apps/abstract.py

@@ -53,8 +53,9 @@ def __init__(
         :param import_name: The name of the package or module that this object belongs to. If you
             are using a single module, __name__ is always the correct value. If you however are
             using a package, it’s usually recommended to hardcode the name of your package there.
+        :param lifespan: A lifespan context function, which can be used to perform startup and
         :param middlewares: The list of middlewares to wrap around the application. Defaults to
-            :obj:`middleware.main.ConnexionmMiddleware.default_middlewares`
+            :obj:`middleware.main.ConnexionMiddleware.default_middlewares`
         :param specification_dir: The directory holding the specification(s). The provided path
             should either be absolute or relative to the root path of the application. Defaults to
             the root path.
@@ -71,8 +72,8 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
-            options for the swagger ui.
+        :param swagger_ui_options: A dict with configuration options for the swagger ui. See
+            :class:`options.ConnexionOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.

connexion/apps/asynchronous.py

@@ -141,8 +141,10 @@ def __init__(
         :param import_name: The name of the package or module that this object belongs to. If you
             are using a single module, __name__ is always the correct value. If you however are
             using a package, it’s usually recommended to hardcode the name of your package there.
+        :param lifespan: A lifespan context function, which can be used to perform startup and
+            shutdown tasks.
         :param middlewares: The list of middlewares to wrap around the application. Defaults to
-            :obj:`middleware.main.ConnexionmMiddleware.default_middlewares`
+            :obj:`middleware.main.ConnexionMiddleware.default_middlewares`
         :param specification_dir: The directory holding the specification(s). The provided path
             should either be absolute or relative to the root path of the application. Defaults to
             the root path.
@@ -159,8 +161,8 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
-            options for the swagger ui.
+        :param swagger_ui_options: A dict with configuration options for the swagger ui. See
+            :class:`options.ConnexionOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.

connexion/apps/flask.py

@@ -201,7 +201,7 @@ def __init__(
         :param lifespan: A lifespan context function, which can be used to perform startup and
             shutdown tasks.
         :param middlewares: The list of middlewares to wrap around the application. Defaults to
-            :obj:`middleware.main.ConnexionmMiddleware.default_middlewares`
+            :obj:`middleware.main.ConnexionMiddleware.default_middlewares`
         :param server_args: Arguments to pass to the Flask application.
         :param specification_dir: The directory holding the specification(s). The provided path
             should either be absolute or relative to the root path of the application. Defaults to
@@ -221,6 +221,8 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
+        :param swagger_ui_options: A dict with configuration options for the swagger ui. See
+            :class:`options.ConnexionOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.

connexion/middleware/main.py

@@ -160,8 +160,8 @@ def __init__(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
-            options for the swagger ui.
+        :param swagger_ui_options: A dict with configuration options for the swagger ui. See
+            :class:`options.ConnexionOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.
@@ -309,8 +309,8 @@ def add_api(
             start.
         :param strict_validation: When True, extra form or query parameters not defined in the
             specification result in a validation error. Defaults to False.
-        :param swagger_ui_options: A :class:`options.ConnexionOptions` instance with configuration
-            options for the swagger ui.
+        :param swagger_ui_options: A dict with configuration options for the swagger ui. See
+            :class:`options.ConnexionOptions`.
         :param uri_parser_class: Class to use for uri parsing. See :mod:`uri_parsing`.
         :param validate_responses: Whether to validate responses against the specification. This has
             an impact on performance. Defaults to False.
@@ -358,6 +358,13 @@ def add_api(
     def add_error_handler(
         self, code_or_exception: t.Union[int, t.Type[Exception]], function: t.Callable
     ) -> None:
+        """
+        Register a callable to handle application errors.
+
+        :param code_or_exception: An exception class or the status code of HTTP exceptions to
+            handle.
+        :param function: Callable that will handle exception.
+        """
         if self.middleware_stack is not None:
             raise RuntimeError(
                 "Cannot add error handler after an application has started"

docs/conf.py

@@ -27,21 +27,14 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['autoapi.extension']
-
-autoapi_type = 'python'
-autoapi_options = ['members',
-                   'inherited-members',
-                   'undoc-members',
-                   'show-inheritance',
-                   'show-module-summary',
-                   'special-members',
-                   'imported-members']
-autoapi_python_class_content = 'both'
-autoapi_dirs = [
-    '../connexion'
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx_copybutton',
+    'sphinx_design',
 ]
 
+autoclass_content = 'both'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']