Skip to content

Commit a5ea630

Browse files
committed
Reference docs
1 parent d3deb81 commit a5ea630

File tree

6 files changed

+298
-42
lines changed

6 files changed

+298
-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: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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
10+
- unmarshal_request
11+
- unmarshal_response
12+
- validate_request
13+
- validate_response

mkdocs.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,24 @@ 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
56+
show_root_heading: true
57+
show_if_no_docstring: true
58+
inherited_members: true
59+
members_order: source
60+
separate_signature: true
61+
unwrap_annotated: true
62+
merge_init_into_class: true
63+
docstring_section_style: spacy
64+
signature_crossrefs: true
65+
show_symbol_type_heading: true
66+
show_symbol_type_toc: true
4967
nav:
5068
- OpenAPI-core: index.md
5169
- unmarshalling.md
@@ -75,6 +93,9 @@ nav:
7593
- customizations/extra_format_unmarshallers.md
7694
- security.md
7795
- extensions.md
96+
- Reference:
97+
- reference/index.md
98+
- reference/openapi.md
7899
- contributing.md
79100
markdown_extensions:
80101
- admonition

0 commit comments

Comments
 (0)