Reference code API docs

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

docs/api/openapi.rst

@@ -0,0 +1,5 @@
+`OpenAPI` class
+===============
+
+.. autoclass:: openapi_core.OpenAPI
+ :members:

docs/conf.py

@@ -38,6 +38,7 @@
  "sphinx.ext.intersphinx",
  "sphinx.ext.coverage",
  "sphinx.ext.viewcode",
+ "sphinx_autodoc_typehints",
  "sphinx_immaterial",
 ]
 

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

openapi_core/app.py

@@ -71,7 +71,17 @@
 
 
 class OpenAPI:
- """OpenAPI class."""
+ """`OpenAPI` application class, the main entrypoint class for OpenAPI-core.
+
+ Read more information, in the 
+ [OpenAPI-core docs for First Steps](https://openapi-core.readthedocs.io/#first-steps).
+
+ Import :class:`OpenAPI` class from the main `openapi_core` module::
+
+ from openapi_core import OpenAPI
+
+ app = OpenAPI(spec)
+ """
 
  def __init__(
  self,
@@ -90,27 +100,31 @@ def __init__(
  def from_dict(
  cls, data: Schema, config: Optional[Config] = None
  ) -> "OpenAPI":
+ """Creates :class:`OpenAPI` class instance from a dictionary."""
  sp = SchemaPath.from_dict(data)
  return cls(sp, config=config)
 
  @classmethod
  def from_path(
  cls, path: Path, config: Optional[Config] = None
  ) -> "OpenAPI":
+ """Creates :class:`OpenAPI` class instance from a path object."""
  sp = SchemaPath.from_path(path)
  return cls(sp, config=config)
 
  @classmethod
  def from_file_path(
  cls, file_path: str, config: Optional[Config] = None
  ) -> "OpenAPI":
+ """Creates :class:`OpenAPI` class instance from a file path string."""
  sp = SchemaPath.from_file_path(file_path)
  return cls(sp, config=config)
 
  @classmethod
  def from_file(
  cls, fileobj: SupportsRead, config: Optional[Config] = None
  ) -> "OpenAPI":
+ """Creates :class:`OpenAPI` class instance from a file object."""
  sp = SchemaPath.from_file(fileobj)
  return cls(sp, config=config)
 

pyproject.toml

@@ -112,6 +112,7 @@ pyflakes = "^3.1.0"
 [tool.poetry.group.docs.dependencies]
 sphinx = ">=5.3,<8.0"
 sphinx-immaterial = "^0.11.0"
+sphinx-autodoc-typehints = "^2.0.0"
 
 [tool.pytest.ini_options]
 addopts = """