Skip to content

Commit 9aa0475

Browse files
authored
add missing ColumnKwargs to docs, and update Sphinx (#1288)
1 parent 20bc3a0 commit 9aa0475

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

docs/src/piccolo/api_reference/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ Column
3030
:members:
3131

3232

33+
.. autoclass:: ColumnKwargs
34+
:members:
35+
:undoc-members:
36+
3337
-------------------------------------------------------------------------------
3438

3539
Aggregate functions

piccolo/columns/base.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,11 @@ def __deepcopy__(self, memo) -> ColumnMeta:
361361

362362

363363
class ColumnKwargs(TypedDict, total=False):
364+
"""
365+
Additional arguments which can be passed to :class:`Column` from
366+
subclasses.
367+
"""
368+
364369
null: bool
365370
primary_key: bool
366371
unique: bool

requirements/doc-requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Sphinx==7.3.7
2-
piccolo-theme==0.23.0
3-
sphinx-autobuild==2021.3.14
1+
Sphinx==8.3.0
2+
piccolo-theme==0.24.0
3+
sphinx-autobuild==2025.8.25

0 commit comments

Comments
 (0)