mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Samuel Colvin
33b7d52d31
* moving docs to mkdocs * transfering readme to md and more * fixing build * splitting usage.md * improving schema.md and index.md * fix make_history.rst * models intro * working on data conversation and required fields * more fixes to models.md * list all standard types supported * list of pydantic types * tweaks * update links in code * Apply suggestions from code review incorporate @dmontagu's suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more missed suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more corrects. * cleanup * Field order warning * fix and regenerate benchmarks * format examples better, cleanup * improve schema mapping table * correct highlighting file types in schema.md * add redirects in javascript * add logo
49 lines
1.0 KiB
YAML
49 lines
1.0 KiB
YAML
site_name: Pydantic
|
|
site_description: Data validation and settings management using python 3.6 type hinting
|
|
strict: true
|
|
site_url: https://pydantic-docs.helpmanual.io/
|
|
|
|
theme:
|
|
name: 'material'
|
|
palette:
|
|
primary: pink
|
|
accent: pink
|
|
logo: 'logo-white.svg'
|
|
favicon: 'favicon.png'
|
|
|
|
repo_name: samuelcolvin/pydantic
|
|
repo_url: https://github.com/samuelcolvin/pydantic
|
|
google_analytics:
|
|
- 'UA-62733018-4'
|
|
- 'auto'
|
|
|
|
nav:
|
|
- Overview: index.md
|
|
- install.md
|
|
- Usage:
|
|
- usage/models.md
|
|
- 'Field Types': usage/types.md
|
|
- usage/validators.md
|
|
- usage/model_config.md
|
|
- usage/schema.md
|
|
- usage/exporting_models.md
|
|
- usage/dataclasses.md
|
|
- 'Settings management': usage/settings.md
|
|
- usage/postponed_annotations.md
|
|
- 'Usage with mypy': usage/mypy.md
|
|
- Contributing to Pydantic: contributing.md
|
|
- benchmarks.md
|
|
- 'PyCharm plugin': pycharm_plugin.md
|
|
- changelog.md
|
|
|
|
markdown_extensions:
|
|
- markdown.extensions.codehilite:
|
|
guess_lang: false
|
|
- markdown_include.include:
|
|
base_path: docs
|
|
- toc:
|
|
permalink: 🔗
|
|
- admonition
|
|
- codehilite
|
|
- extra
|