update docs (#62)

* update docs

* keep line width

* fix mkdocstrings warning

Author: NiklasRosenstein

databind.core/README.md

@@ -0,0 +1,3 @@
+
+Deprecated since v4.5.0. This is a proxy for depending on [`databind`](https://pypi.org/project/databind/). Do not
+depend on this package directly anymore.

databind.json/README.md

@@ -1,47 +1,3 @@
-# databind.json
 
-The `databind.json` package implements the de-/serialization to or from JSON payloads using
-the `databind.core` framework.
-
-Check out the [Documentation][0] for examples.
-
-[0]: https://niklasrosenstein.github.io/python-databind/
-
-## Built-in converters
-
-The following tables shows which types can be deserialized from / serialize to Python types with the native
-converters provided by the `databind.json` module:
-
-| Converter name | Types | Description |
-| -------------- | ----- | ----------- |
-| `AnyConverter` | `typing.Any` | Accept any value (useful for arbitrary JSON). |
-| `CollectionConverter` | `typing.Collection[T]`, excl. `str`, `bytes`, `bytearray`, `memoryview` and `typing.Mapping[K, V]` | Converts between native Python collections and JSON arrays. |
-| `DatetimeConverter` | `datetime.date`, `datetime.datetime`, `datetime.time` | Converts between strings and date/time formats, using ISO 8601 time format by default (can be changed with the `databind.core.settings.DateFormat` setting). |
-| `DecimalConverter` | `decimal.Decimal` | Converts between strings (and ints/floats if strict mode is off, strict mode is on by default) and decimals. The precision can be controlled with the `databind.core.settings.Precision` setting. |
-| `EnumConverter` | `enum.Enum`, `enum.IntEnum` | Convert between strings and Python enumerations. The serialized form of `IntEnum` is the integer value, whereas the serialized form of `Enum` is a string (name of the enumeration value). |
-| `MappingConverter` | `typing.Mapping[K, V]` | Converts between Python dicts and JSON objects. (While in theory `K` can be any type, for JSON `K` always needs to be `str`). |
-| `OptionalConverter` | `typing.Optional[T]` | Handles optional fields in a schema. |
-| `PlainDatatypeConverter` | `bytes`, `str`, `int`, `float`, `bool` | Converts between plain datatypes. In non-strict mode (off by default), numeric types will also accept strings as input for the deserialization. |
-| `SchemaConverter` | `dataclasses.dataclass`, `typing.TypedDict` | Converts between Python dataclasses or typed dictionary and JSON objects. |
-| `UnionConverter` | `typing.Union[...]` | Handles union types. Unions in JSON can be expressed in a multitide of ways, e.g. using a discriminator key and flat, keyed or nested structure or "best match". Check out the examples section of the documentation for more information. |
-| `LiteralConverter` | `typing.Literal[...]` | Accepts or rejects a value based on whether it matches one of the values in the literal type hint. |
-
-
-The following converters are provided for convenience:
-
-| Converter name | Types | Description |
-| -------------- | ----- | ----------- |
-| `StringifyConverter` | n/a | A helper that allows to easily create de/serializers from a "to string" and "from string" function. |
-
-The following additional types are natively supported by `databind.json` using `StringifyConverter`:
-
-| Types | Description |
-| ----- | ----------- |
-| `uuid.UUID` | Convert between strings and UUIDs. |
-| `pathlib.Path` | Convert between strings and paths. |
-| `pathlib.PurePath` | Convert between strings and paths. |
-| `nr.date.duration` | Deserialize from ISO 8601 duration strings or the object form, serialize to ISO 8601 strings. |
-
----
-
-<p align="center">Copyright &copy; 2020 &ndash; Niklas Rosenstein</p>
+Deprecated since v4.5.0. This is a proxy for depending on [`databind`](https://pypi.org/project/databind/). Do not
+depend on this package directly anymore.

databind/README.md

@@ -11,7 +11,8 @@
 The `databind` package provides a (de)serialization framework that understands most native Python types as well as
 dataclasses, as well as an implementation for serialize to/from JSON-like nested data structures.
 
-Databind is intended mostly for flexible and easy to use configuration loading. It does __not__ try achieve high-performance; you should look towards e.g. [mashumaro](https://pypi.org/project/mashumaro/) for this usecase.
+Databind is intended mostly for flexible and easy to use configuration loading. It does __not__ try achieve
+high-performance; you should look towards e.g. [mashumaro](https://pypi.org/project/mashumaro/) for this usecase.
 
 ### Example
 
@@ -38,10 +39,12 @@ assert dump(loaded, Config) == dict_payload
 
   [typeapi]: https://github.com/NiklasRosenstein/python-typeapi
 
-* Support for a plethora of builtin types, including `Enum`, `Decimal`, `UUID`, `Path`, `datetime`, `date`, `time`, `timedelta`
+* Support for a plethora of builtin types, including `Enum`, `Decimal`, `UUID`, `Path`, `datetime`, `date`,
+  `time`, `timedelta`
 * Support for multiple union serialization modes (nested, flat, keyed, `typing.Literal`)
 * Support for generic types, e.g. `load([{"name": "Jane Doe"}], list[Person])`
-* Support for new-style type hints in older Python versions when using forward refererences (strings or `__future__.annotations`) thanks to [typeapi][]
+* Support for new-style type hints in older Python versions when using forward refererences (strings or
+  `__future__.annotations`) thanks to [typeapi][]
     * [PEP 604 - Allow writing union types as X | Y](https://www.python.org/dev/peps/pep-0604/)
     * [PEP585 - Type Hinting Generics in Standard Collections](https://www.python.org/dev/peps/pep-0585/))
 * Support for customized serialization and deserialization of types
@@ -50,7 +53,8 @@ assert dump(loaded, Config) == dict_payload
 * Use "settings" to customize serialization behaviour
     * As global settings per `load()`/`dump()` call: `load(..., settings=[ExtraKeys(True)])`
     * As class-level settings using a decorator: `@Union(style=Union.FLAT)` or `@ExtraKeys(True)`
-    * As type-hint level settings using `typing.Annotated` (or `typing_extensions.Annotated`): `full_name: Annotated[str, Alias("fullName")]` or `FullNameField = Annotated[str, Alias("fullName")]`
+    * As type-hint level settings using `typing.Annotated` (or `typing_extensions.Annotated`):
+      `full_name: Annotated[str, Alias("fullName")]` or `FullNameField = Annotated[str, Alias("fullName")]`
 
 ## Notable release notes
 

databind/pyproject.toml

@@ -27,6 +27,15 @@ types-deprecated = "*"
 types-setuptools = "*"
 types-termcolor = "*"
 
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "*"
+mkdocs-material = "*"
+mkdocstrings = {version = "*", extras = ["python"]}
+mksync = "^0.1.4"
+
 [build-system]
 requires = ["poetry-core==1.9.0"]
 build-backend = "poetry.core.masonry.api"

databind/src/databind/core/settings.py

@@ -620,7 +620,7 @@ def format(self, dt: T_Dtype) -> str:
         """Format a date/time value to a string.
 
         Arguments:
-          value: The date/time value to format (i.e. an instance of #datetime.date, #datetime.time or
+          dt: The date/time value to format (i.e. an instance of #datetime.date, #datetime.time or
             #datetime.datetime).
         Raises:
           ValueError: If no date format to format the type of *value* is available.