Files
pydantic/mkdocs.yml
T
Samuel Colvin f341049b9e Remove Cython & Move to pyproject.toml (#4473)
* Remove Cython

* fix CI

* fix coverage

* fix tests

* switching to pypyroject.toml

* pre-commit all and use pre-commit for linting

* no mypy tests on macos and windows on ci, use flake8-pyproject

* fix docs and tests CI

* check build is working

* drop pytest-cov

* window and macos ci with 3.11, reduce filtering

* use pip-tools to pin all dependencies

* fix docs and fastapi tests

* fix test deps for 3.7

* no cache on tests job

* revert fastapi changes, fix coverage

* fix mypy coverage

* test with older mypy

* dotenv not required for mypy tests

* split testing requirements std and extra

* typo

* @PrettyWood comments

* correct branch name

* mypy python_version and pr template
2022-09-06 17:15:51 +01:00

94 lines
2.1 KiB
YAML

site_name: pydantic
site_description: Data validation and settings management using Python type hints
strict: true
site_url: https://pydantic-docs.helpmanual.io/
theme:
name: 'material'
custom_dir: 'docs/theme'
palette:
- 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
name: "Switch to light mode"
features:
- content.tabs.link
logo: 'logo-white.svg'
favicon: 'favicon.png'
repo_name: pydantic/pydantic
repo_url: https://github.com/pydantic/pydantic
extra:
analytics:
provider: google
property: UA-62733018-4
extra_css:
- 'extra/terminal.css'
- 'extra/tweaks.css'
extra_javascript:
- 'extra/redirects.js'
- 'extra/ad.js'
nav:
- Overview: index.md
- install.md
- Usage:
- usage/models.md
- 'Field Types': usage/types.md
- usage/validators.md
- 'Model Config': usage/model_config.md
- usage/schema.md
- usage/exporting_models.md
- usage/dataclasses.md
- usage/validation_decorator.md
- 'Settings management': usage/settings.md
- usage/postponed_annotations.md
- 'Usage with mypy': usage/mypy.md
- 'Usage with devtools': usage/devtools.md
- 'Usage with rich': usage/rich.md
- Blog:
- blog/pydantic-v2.md
- Contributing to pydantic: contributing.md
- 'Mypy plugin': mypy_plugin.md
- 'PyCharm plugin': pycharm_plugin.md
- 'Visual Studio Code': visual_studio_code.md
- 'Hypothesis plugin': hypothesis_plugin.md
- 'Code Generation': datamodel_code_generator.md
- changelog.md
markdown_extensions:
- tables
- markdown_include.include:
base_path: docs
- toc:
permalink: true
- admonition
- pymdownx.highlight
- pymdownx.extra
- mdx_truly_sane_lists
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
- exclude:
glob:
- _build/*
- build/*
- examples/*
- requirements.txt