Skip to content

Commit a030b76

Browse files
authored
docs: Revamp documentation with pydata theme (#200)
1 parent 91961d5 commit a030b76

File tree

84 files changed

+1084
-731
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1084
-731
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ instance/
213213

214214
# Sphinx documentation
215215
docs/_build/
216+
docs/**/_gen/
216217

217218
# PyBuilder
218219
.pybuilder/

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ repos:
9393
entry: pixi run -e lint check-merge-conflict --assume-in-merge
9494
language: system
9595
types: [text]
96+
exclude: \.rst$
9697
# typos
9798
- id: typos
9899
name: typos

dataframely/columns/_base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ def __init__(
6464
in the same name, the suffix __i is appended to the name.
6565
- A dictionary mapping rule names to callables, where each callable
6666
returns a non-aggregated boolean expression.
67-
All rule names provided here are given the prefix "check_".
67+
All rule names provided here are given the prefix `"check_"`.
6868
alias: An overwrite for this column's name which allows for using a column
6969
name that is not a valid Python identifier. Especially note that setting
7070
this option does _not_ allow to refer to the column with two different

dataframely/columns/any.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def __init__(
4141
in the same name, the suffix __i is appended to the name.
4242
- A dictionary mapping rule names to callables, where each callable
4343
returns a non-aggregated boolean expression.
44-
All rule names provided here are given the prefix "check_".
44+
All rule names provided here are given the prefix `"check_"`.
4545
alias: An overwrite for this column's name which allows for using a column
4646
name that is not a valid Python identifier. Especially note that setting
4747
this option does _not_ allow to refer to the column with two different

dataframely/columns/array.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def __init__(
5757
in the same name, the suffix __i is appended to the name.
5858
- A dictionary mapping rule names to callables, where each callable
5959
returns a non-aggregated boolean expression.
60-
All rule names provided here are given the prefix "check_".
60+
All rule names provided here are given the prefix `"check_"`.
6161
alias: An overwrite for this column's name which allows for using a column
6262
name that is not a valid Python identifier. Especially note that setting
6363
this option does _not_ allow to refer to the column with two different

dataframely/columns/categorical.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def __init__(
4545
in the same name, the suffix __i is appended to the name.
4646
- A dictionary mapping rule names to callables, where each callable
4747
returns a non-aggregated boolean expression.
48-
All rule names provided here are given the prefix "check_".
48+
All rule names provided here are given the prefix `"check_"`.
4949
alias: An overwrite for this column's name which allows for using a column
5050
name that is not a valid Python identifier. Especially note that setting
5151
this option does _not_ allow to refer to the column with two different

dataframely/columns/datetime.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def __init__(
7373
in the same name, the suffix __i is appended to the name.
7474
- A dictionary mapping rule names to callables, where each callable
7575
returns a non-aggregated boolean expression.
76-
All rule names provided here are given the prefix "check_".
76+
All rule names provided here are given the prefix `"check_"`.
7777
alias: An overwrite for this column's name which allows for using a column
7878
name that is not a valid Python identifier. Especially note that setting
7979
this option does _not_ allow to refer to the column with two different
@@ -196,7 +196,7 @@ def __init__(
196196
in the same name, the suffix __i is appended to the name.
197197
- A dictionary mapping rule names to callables, where each callable
198198
returns a non-aggregated boolean expression.
199-
All rule names provided here are given the prefix "check_".
199+
All rule names provided here are given the prefix `"check_"`.
200200
alias: An overwrite for this column's name which allows for using a column
201201
name that is not a valid Python identifier. Especially note that setting
202202
this option does _not_ allow to refer to the column with two different
@@ -331,7 +331,7 @@ def __init__(
331331
in the same name, the suffix __i is appended to the name.
332332
- A dictionary mapping rule names to callables, where each callable
333333
returns a non-aggregated boolean expression.
334-
All rule names provided here are given the prefix "check_".
334+
All rule names provided here are given the prefix `"check_"`.
335335
alias: An overwrite for this column's name which allows for using a column
336336
name that is not a valid Python identifier. Especially note that setting
337337
this option does _not_ allow to refer to the column with two different
@@ -472,7 +472,7 @@ def __init__(
472472
in the same name, the suffix __i is appended to the name.
473473
- A dictionary mapping rule names to callables, where each callable
474474
returns a non-aggregated boolean expression.
475-
All rule names provided here are given the prefix "check_".
475+
All rule names provided here are given the prefix `"check_"`.
476476
alias: An overwrite for this column's name which allows for using a column
477477
name that is not a valid Python identifier. Especially note that setting
478478
this option does _not_ allow to refer to the column with two different

dataframely/columns/decimal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def __init__(
6363
in the same name, the suffix __i is appended to the name.
6464
- A dictionary mapping rule names to callables, where each callable
6565
returns a non-aggregated boolean expression.
66-
All rule names provided here are given the prefix "check_".
66+
All rule names provided here are given the prefix `"check_"`.
6767
alias: An overwrite for this column's name which allows for using a column
6868
name that is not a valid Python identifier. Especially note that setting
6969
this option does _not_ allow to refer to the column with two different

dataframely/columns/enum.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def __init__(
5252
in the same name, the suffix __i is appended to the name.
5353
- A dictionary mapping rule names to callables, where each callable
5454
returns a non-aggregated boolean expression.
55-
All rule names provided here are given the prefix "check_".
55+
All rule names provided here are given the prefix `"check_"`.
5656
alias: An overwrite for this column's name which allows for using a column
5757
name that is not a valid Python identifier. Especially note that setting
5858
this option does _not_ allow to refer to the column with two different

dataframely/columns/float.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ def __init__(
6464
in the same name, the suffix __i is appended to the name.
6565
- A dictionary mapping rule names to callables, where each callable
6666
returns a non-aggregated boolean expression.
67-
All rule names provided here are given the prefix "check_".
67+
All rule names provided here are given the prefix `"check_"`.
6868
alias: An overwrite for this column's name which allows for using a column
6969
name that is not a valid Python identifier. Especially note that setting
7070
this option does _not_ allow to refer to the column with two different

0 commit comments

Comments
 (0)