docs: Revamp documentation with pydata theme

.gitignore

@@ -213,6 +213,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/**/_gen/
 
 # PyBuilder
 .pybuilder/

.pre-commit-config.yaml

@@ -93,6 +93,7 @@ repos:
         entry: pixi run -e lint check-merge-conflict --assume-in-merge
         language: system
         types: [text]
+        exclude: \.rst$
       # typos
       - id: typos
         name: typos

dataframely/columns/_base.py

@@ -64,7 +64,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/any.py

@@ -41,7 +41,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/array.py

@@ -57,7 +57,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/categorical.py

@@ -45,7 +45,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/datetime.py

@@ -73,7 +73,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different
@@ -196,7 +196,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different
@@ -331,7 +331,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different
@@ -472,7 +472,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/decimal.py

@@ -63,7 +63,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/enum.py

@@ -52,7 +52,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/float.py

@@ -64,7 +64,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/integer.py

@@ -61,7 +61,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/list.py

@@ -61,7 +61,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/object.py

@@ -41,7 +41,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/string.py

@@ -53,7 +53,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/columns/struct.py

@@ -56,7 +56,7 @@ def __init__(
                 in the same name, the suffix __i is appended to the name.
                 - A dictionary mapping rule names to callables, where each callable
                 returns a non-aggregated boolean expression.
-                All rule names provided here are given the prefix "check_".
+                All rule names provided here are given the prefix `"check_"`.
             alias: An overwrite for this column's name which allows for using a column
                 name that is not a valid Python identifier. Especially note that setting
                 this option does _not_ allow to refer to the column with two different

dataframely/exc.py

@@ -40,4 +40,4 @@ def __init__(self, attr: str, kls: type) -> None:
 
 
 class ValidationRequiredError(Exception):
-    """Error raised when validation is when reading a parquet file."""
+    """Error raised when validation is required when reading a parquet file."""

dataframely/filter_result.py

@@ -89,7 +89,7 @@ class FailureInfo(Generic[S]):
 
     #: The subset of the input data frame containing the *invalid* rows along with
     #: all boolean columns used for validation. Each of these boolean columns describes
-    #: a single rule where a value of `False``` indicates unsuccessful validation.
+    #: a single rule where a value of `False` indicates unsuccessful validation.
     #: Thus, at least one value per row is `False`.
     _lf: pl.LazyFrame
     #: The columns in `_lf` which are used for validation.
@@ -150,7 +150,7 @@ def write_parquet(self, file: str | Path | IO[bytes], **kwargs: Any) -> None:
                 parquet file. This should be a path to a directory if writing a
                 partitioned dataset.
             kwargs: Additional keyword arguments passed directly to
-                :meth:`polars.write_parquet`. `metadata` may only be provided if it
+                :meth:`polars.write_parquet`. ``metadata`` may only be provided if it
                 is a dictionary.
 
         Attention:
@@ -169,7 +169,7 @@ def sink_parquet(
                 parquet file. This should be a path to a directory if writing a
                 partitioned dataset.
             kwargs: Additional keyword arguments passed directly to
-                :meth:`polars.sink_parquet`. `metadata` may only be provided if it
+                :meth:`polars.sink_parquet`. ``metadata`` may only be provided if it
                 is a dictionary.
 
         Attention:

dataframely/schema.py

@@ -893,9 +893,9 @@ def read_parquet(
                   returns if the schema stored in the parquet file's metadata matches
                   this schema.
                 - `"skip"`: The method never runs validation and simply reads the
-                  parquet file, entrusting the user that the schema is valid. _Use this
+                  parquet file, entrusting the user that the schema is valid. *Use this
                   option carefully and consider replacing it with
-                  :meth:`polars.read_parquet` to convey the purpose better_.
+                  :meth:`polars.read_parquet` to convey the purpose better*.
 
             kwargs: Additional keyword arguments passed directly to
                 :meth:`polars.read_parquet`.
@@ -949,9 +949,9 @@ def scan_parquet(
                   returns if the schema stored in the parquet file's metadata matches
                   this schema.
                 - `"skip"`: The method never runs validation and simply reads the
-                  parquet file, entrusting the user that the schema is valid. _Use this
+                  parquet file, entrusting the user that the schema is valid. *Use this
                   option carefully and consider replacing it with
-                  :meth:`polars.scan_parquet` to convey the purpose better_.
+                  :meth:`polars.scan_parquet` to convey the purpose better*.
 
             kwargs: Additional keyword arguments passed directly to
                 :meth:`polars.scan_parquet`.
@@ -1076,9 +1076,9 @@ def scan_delta(
                   returns if the schema stored in the parquet file's metadata matches
                   this schema.
                 - `"skip"`: The method never runs validation and simply reads the
-                  parquet file, entrusting the user that the schema is valid. _Use this
+                  parquet file, entrusting the user that the schema is valid. *Use this
                   option carefully and consider replacing it with
-                  :meth:`polars.scan_delta` to convey the purpose better_.
+                  :meth:`polars.scan_delta` to convey the purpose better*.
 
             kwargs: Additional keyword arguments passed directly to :meth:`polars.scan_delta`.
 
@@ -1133,9 +1133,9 @@ def read_delta(
                   returns if the schema stored in the parquet file's metadata matches
                   this schema.
                 - `"skip"`: The method never runs validation and simply reads the
-                  parquet file, entrusting the user that the schema is valid. _Use this
+                  parquet file, entrusting the user that the schema is valid. *Use this
                   option carefully and consider replacing it with
-                  :meth:`polars.read_delta` to convey the purpose better_.
+                  :meth:`polars.read_delta` to convey the purpose better*.
 
             kwargs: Additional keyword arguments passed directly to :meth:`polars.read_delta`.