1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
site_name: Typing inspection
site_description: Runtime typing introspection tools
strict: true
site_url: https://typing-inspection.pydantic.dev
theme:
name: material
features:
- content.code.copy
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.instant.progress
- navigation.top
palette:
- media: (prefers-color-scheme)
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: Switch to light mode
- media: '(prefers-color-scheme: light)'
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: pink
accent: pink
toggle:
icon: material/lightbulb-auto-outline
name: Switch to system preference
icon:
view: material/eye
repo: fontawesome/brands/github
repo_name: pydantic/typing-inspection
repo_url: https://github.com/pydantic/typing-inspection
edit_uri: edit/main/docs/
extra:
version:
provider: mike
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
extra_css:
- extra/tweaks.css
nav:
- Index: index.md
- Usage: usage.md
- API documentation:
- introspection: api/introspection.md
- typing_objects: api/typing_objects.md
markdown_extensions:
- toc:
permalink: true
title: Page contents
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.extra
- pymdownx.tabbed:
alternate_style: true
hooks:
- docs/.hooks/rename_module.py
plugins:
- search
- mike:
alias_type: symlink
canonical_version: latest
- mkdocstrings:
handlers:
python:
paths: [src]
options:
show_source: false
members_order: source
separate_signature: true
filters: ["!^_"]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_signature_annotations: true
signature_crossrefs: true
inventories:
- url: https://docs.python.org/3/objects.inv
domains: [py, std]
- url: https://typing.readthedocs.io/en/latest/objects.inv
domains: [std]
- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
domains: [py, std]
|