Samuel Colvin 33b7d52d31 moving docs to mkdocs (#856) ...

* 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

2019-10-07 17:19:01 +01:00

..

advanced_exclude1.py

Add advanced exclude and include support for dict, json and copy (#648)

2019-07-24 09:58:38 +01:00

advanced_exclude2.py

Add advanced exclude and include support for dict, json and copy (#648)

2019-07-24 09:58:38 +01:00

alias_generator_config.py

Add alias_generator (#622)

2019-07-02 12:13:06 +01:00

bare_type_type.py

Add support for Type[T] typehints when arbitrary_types_allowed==True. (#808)

2019-09-16 10:42:40 +01:00

boolean.py

Added generic approach to strict type checking for constrained types (#799)

2019-09-17 12:38:51 +01:00

callable.py

Support typing.Callable validation. (#364)

2019-01-29 15:42:00 +00:00

choices.py

add support for annotation only fields (#41)

2017-06-07 19:56:46 +01:00

config.py

improve docs on error handling (#198)

2018-06-11 13:06:50 +01:00

constrained_types.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

custom_data_types.py

reame get_validators > __get_validators__ (#338)

2018-12-27 20:30:41 +00:00

custom_root_field.py

Serialize only __root__ value (#752)

2019-08-17 18:58:32 +01:00

data_conversion.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

datetime_example.py

Validators for dataclasses (#454)

2019-04-11 23:13:57 +01:00

dynamic_inheritance.py

Create model method (#125)

2018-02-06 14:29:56 +00:00

dynamic_model_creation.py

Create model method (#125)

2018-02-06 14:29:56 +00:00

errors1.py

improve docs on error handling (#198)

2018-06-11 13:06:50 +01:00

errors2.py

timedelta json encoding (#247)

2018-08-25 17:06:32 +01:00

errors3.py

improve docs on error handling (#198)

2018-06-11 13:06:50 +01:00

ex_abc.py

Subclass abcmeta (#123)

2018-02-06 13:56:45 +00:00

ex_color_type.py

Colors (#516)

2019-05-22 13:14:35 +01:00

ex_dataclasses_config.py

Add support for passing Configs to Dataclasses (#285)

2018-12-27 17:54:17 +00:00

ex_dataclasses.py

Dataclasses (#269)

2018-10-01 09:48:28 +01:00

ex_json_type.py

fix json documentation (#253)

2018-08-29 10:38:02 +01:00

ex_nested_dataclasses.py

new URL parsing (#755)

2019-09-02 11:37:33 +01:00

ex_post_init_post_parse_initvars.py

Added initvars support to post_init_post_parse (#748)

2019-08-16 09:36:56 +01:00

ex_post_init_post_parse.py

added feature post_init_post_parse (#567)

2019-06-04 10:01:09 +01:00

ex_secret_types.py

fix: serialize secrets to json. (#465)

2019-04-11 19:32:28 +01:00

ex_typing.py

Feature/frozenset support (#762)

2019-08-21 13:13:46 +01:00

example1.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

example2_output.json

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

example2.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

export_copy.py

alter the behaviour of dict(model) so that sub-models are nolonger converted to dictionaries (#733)

2019-08-12 11:31:35 +01:00

export_dict.py

alter the behaviour of dict(model) so that sub-models are nolonger converted to dictionaries (#733)

2019-08-12 11:31:35 +01:00

export_iterate.py

alter the behaviour of dict(model) so that sub-models are nolonger converted to dictionaries (#733)

2019-08-12 11:31:35 +01:00

export_json.py

Fixed example with datetime JSON encoder (#846)

2019-09-30 14:08:41 +01:00

export_pickle.py

alter the behaviour of dict(model) so that sub-models are nolonger converted to dictionaries (#733)

2019-08-12 11:31:35 +01:00

field_order.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

forward_ref.py

support postponed annotations and ForwardRef in python 3.7 (#348)

2019-01-11 21:01:07 +00:00

generics.py

Add generic functionality (#595), fix #556

2019-06-19 11:22:06 +01:00

json_orjson.py

custom json (de)serialisation (#823)

2019-09-30 14:34:30 +01:00

json_ujson.py

custom json (de)serialisation (#823)

2019-09-30 14:34:30 +01:00

literal1.py

Add literal docs (#651)

2019-07-23 16:40:28 +01:00

literal2.py

Add literal docs (#651)

2019-07-23 16:40:28 +01:00

literal3.py

Add literal docs (#651)

2019-07-23 16:40:28 +01:00

mutation.py

Immutability part 2 (#53)

2017-06-21 18:15:08 +01:00

mypy.py

add support for annotation only fields (#41)

2017-06-07 19:56:46 +01:00

orm_mode_recursive.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

orm_mode.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

parse.py

remove msgpack (#201)

2018-06-18 12:20:10 +01:00

payment_card_number.py

PaymentCardNumber type (#790)

2019-09-17 10:33:11 +01:00

postponed_annotations.py

support postponed annotations and ForwardRef in python 3.7 (#348)

2019-01-11 21:01:07 +00:00

postponed_broken.py

support ForwardRef on dataclasses (#399)

2019-02-18 08:41:35 +00:00

postponed_works.py

support ForwardRef on dataclasses (#399)

2019-02-18 08:41:35 +00:00

recursive.py

moving docs to mkdocs (#856)

2019-10-07 17:19:01 +01:00

schema1.json

Add additional parameters to Schema for validation and annotation (#319)

2018-12-03 12:37:39 +00:00

schema1.py

rename Schema to Field (#824)

2019-09-30 17:49:59 +01:00

schema2.json

JSON Schema update/refactor/augment, to conform to spec (#308)

2018-11-22 16:00:06 +00:00

schema2.py

JSON Schema update/refactor/augment, to conform to spec (#308)

2018-11-22 16:00:06 +00:00

schema3.json

JSON Schema update/refactor/augment, to conform to spec (#308)

2018-11-22 16:00:06 +00:00

schema3.py

JSON Schema update/refactor/augment, to conform to spec (#308)

2018-11-22 16:00:06 +00:00

schema4.json

Add example and docs for schema_extra in Config

2019-08-05 09:45:37 -05:00

schema4.py

Fix double quotes to single quotes

2019-08-05 09:47:15 -05:00

self_referencing_annotations.py

improve doc on self-referencing models and annotations (#487)

2019-04-24 10:06:03 +01:00

self_referencing_string.py

improve doc on self-referencing models and annotations (#487)

2019-04-24 10:06:03 +01:00

settings_case_sensitive.py

Change defaults for BaseSettings (#747)

2019-08-21 12:48:28 +01:00

settings.py

change how env variables work with settings (#847)

2019-10-01 16:32:02 +01:00

strict_types.py

Added generic approach to strict type checking for constrained types (#799)

2019-09-17 12:38:51 +01:00

type_type.py

Add support for Type[T] typehints when arbitrary_types_allowed==True. (#808)

2019-09-16 10:42:40 +01:00

union_type_correct.py

Clarification around usage of Union (#594)

2019-06-15 14:05:47 +01:00

union_type_incorrect.py

Clarification around usage of Union (#594)

2019-06-15 14:05:47 +01:00

url_properties.py

new URL parsing (#755)

2019-09-02 11:37:33 +01:00

url_punycode.py

new URL parsing (#755)

2019-09-02 11:37:33 +01:00

urls.py

new URL parsing (#755)

2019-09-02 11:37:33 +01:00

validators_always.py

Validator always (#102)

2017-11-08 14:37:01 +00:00

validators_dataclass.py

Validators for dataclasses (#454)

2019-04-11 23:13:57 +01:00

validators_pre_item.py

None behaviour (#803)

2019-09-18 11:38:21 +01:00

validators_root.py

Root validators (#817)

2019-09-30 17:19:44 +01:00

validators_simple.py

Root validators (#817)

2019-09-30 17:19:44 +01:00