Skip to content

Commit bbf7d19

Browse files
committed
Reference docs
1 parent d3deb81 commit bbf7d19

File tree

6 files changed

+283
-42
lines changed

6 files changed

+283
-42
lines changed

docs/reference/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Reference
2+
3+
Documentation with information of functions, classes or methods and all other parts of the OpenAPI-core public API.

docs/reference/openapi.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# `OpenAPI` class
2+
3+
::: openapi_core.OpenAPI
4+
options:
5+
members:
6+
- from_dict
7+
- from_path
8+
- from_file_path
9+
- from_file

mkdocs.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ theme:
4646
- toc.follow
4747
repo_name: python-openapi/openapi-core
4848
repo_url: https://github.com/python-openapi/openapi-core
49+
plugins:
50+
- mkdocstrings:
51+
handlers:
52+
python:
53+
options:
54+
extensions:
55+
- griffe_typingdoc
4956
nav:
5057
- OpenAPI-core: index.md
5158
- unmarshalling.md
@@ -75,6 +82,9 @@ nav:
7582
- customizations/extra_format_unmarshallers.md
7683
- security.md
7784
- extensions.md
85+
- Reference:
86+
- reference/index.md
87+
- reference/openapi.md
7888
- contributing.md
7989
markdown_extensions:
8090
- admonition

0 commit comments

Comments
 (0)