[docs] API docs contain __tag__, improved core reference

alexrudy · Mar 26, 2024 · b38fe52 · b38fe52
1 parent 16a78d1
commit b38fe52
Show file tree

Hide file tree

Showing 61 changed files with 1,571 additions and 29 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/api/bootlace.forms.fields.BooleanField.rst b/docs/api/bootlace.forms.fields.BooleanField.rst
@@ -10,22 +10,50 @@ BooleanField
 
    .. autosummary::
 
+      ~BooleanField.do_not_call_in_templates
+      ~BooleanField.errors
       ~BooleanField.false_values
+      ~BooleanField.process_errors
+      ~BooleanField.raw_data
+      ~BooleanField.validators
       ~BooleanField.widget
 
    .. rubric:: Methods Summary
 
    .. autosummary::
 
+      ~BooleanField.__call__
+      ~BooleanField.check_validators
+      ~BooleanField.gettext
+      ~BooleanField.ngettext
+      ~BooleanField.populate_obj
+      ~BooleanField.post_validate
+      ~BooleanField.pre_validate
+      ~BooleanField.process
       ~BooleanField.process_data
       ~BooleanField.process_formdata
+      ~BooleanField.validate
 
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
    .. autoattribute:: false_values
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
 
    .. rubric:: Methods Documentation
 
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
    .. automethod:: process_data
    .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.ColorField.rst b/docs/api/bootlace.forms.fields.ColorField.rst
@@ -10,8 +10,48 @@ ColorField
 
    .. autosummary::
 
+      ~ColorField.do_not_call_in_templates
+      ~ColorField.errors
+      ~ColorField.process_errors
+      ~ColorField.raw_data
+      ~ColorField.validators
       ~ColorField.widget
 
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~ColorField.__call__
+      ~ColorField.check_validators
+      ~ColorField.gettext
+      ~ColorField.ngettext
+      ~ColorField.populate_obj
+      ~ColorField.post_validate
+      ~ColorField.pre_validate
+      ~ColorField.process
+      ~ColorField.process_data
+      ~ColorField.process_formdata
+      ~ColorField.validate
+
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
+   .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.DateField.rst b/docs/api/bootlace.forms.fields.DateField.rst
@@ -10,18 +10,48 @@ DateField
 
    .. autosummary::
 
+      ~DateField.do_not_call_in_templates
+      ~DateField.errors
+      ~DateField.process_errors
+      ~DateField.raw_data
+      ~DateField.validators
       ~DateField.widget
 
    .. rubric:: Methods Summary
 
    .. autosummary::
 
+      ~DateField.__call__
+      ~DateField.check_validators
+      ~DateField.gettext
+      ~DateField.ngettext
+      ~DateField.populate_obj
+      ~DateField.post_validate
+      ~DateField.pre_validate
+      ~DateField.process
+      ~DateField.process_data
       ~DateField.process_formdata
+      ~DateField.validate
 
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
 
    .. rubric:: Methods Documentation
 
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
    .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.DateTimeField.rst b/docs/api/bootlace.forms.fields.DateTimeField.rst
@@ -10,18 +10,48 @@ DateTimeField
 
    .. autosummary::
 
+      ~DateTimeField.do_not_call_in_templates
+      ~DateTimeField.errors
+      ~DateTimeField.process_errors
+      ~DateTimeField.raw_data
+      ~DateTimeField.validators
       ~DateTimeField.widget
 
    .. rubric:: Methods Summary
 
    .. autosummary::
 
+      ~DateTimeField.__call__
+      ~DateTimeField.check_validators
+      ~DateTimeField.gettext
+      ~DateTimeField.ngettext
+      ~DateTimeField.populate_obj
+      ~DateTimeField.post_validate
+      ~DateTimeField.pre_validate
+      ~DateTimeField.process
+      ~DateTimeField.process_data
       ~DateTimeField.process_formdata
+      ~DateTimeField.validate
 
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
 
    .. rubric:: Methods Documentation
 
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
    .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.DateTimeLocalField.rst b/docs/api/bootlace.forms.fields.DateTimeLocalField.rst
@@ -10,8 +10,48 @@ DateTimeLocalField
 
    .. autosummary::
 
+      ~DateTimeLocalField.do_not_call_in_templates
+      ~DateTimeLocalField.errors
+      ~DateTimeLocalField.process_errors
+      ~DateTimeLocalField.raw_data
+      ~DateTimeLocalField.validators
       ~DateTimeLocalField.widget
 
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~DateTimeLocalField.__call__
+      ~DateTimeLocalField.check_validators
+      ~DateTimeLocalField.gettext
+      ~DateTimeLocalField.ngettext
+      ~DateTimeLocalField.populate_obj
+      ~DateTimeLocalField.post_validate
+      ~DateTimeLocalField.pre_validate
+      ~DateTimeLocalField.process
+      ~DateTimeLocalField.process_data
+      ~DateTimeLocalField.process_formdata
+      ~DateTimeLocalField.validate
+
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
+   .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.DecimalField.rst b/docs/api/bootlace.forms.fields.DecimalField.rst
@@ -10,18 +10,48 @@ DecimalField
 
    .. autosummary::
 
+      ~DecimalField.do_not_call_in_templates
+      ~DecimalField.errors
+      ~DecimalField.process_errors
+      ~DecimalField.raw_data
+      ~DecimalField.validators
       ~DecimalField.widget
 
    .. rubric:: Methods Summary
 
    .. autosummary::
 
+      ~DecimalField.__call__
+      ~DecimalField.check_validators
+      ~DecimalField.gettext
+      ~DecimalField.ngettext
+      ~DecimalField.populate_obj
+      ~DecimalField.post_validate
+      ~DecimalField.pre_validate
+      ~DecimalField.process
+      ~DecimalField.process_data
       ~DecimalField.process_formdata
+      ~DecimalField.validate
 
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
 
    .. rubric:: Methods Documentation
 
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
    .. automethod:: process_formdata
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.DecimalRangeField.rst b/docs/api/bootlace.forms.fields.DecimalRangeField.rst
@@ -10,8 +10,48 @@ DecimalRangeField
 
    .. autosummary::
 
+      ~DecimalRangeField.do_not_call_in_templates
+      ~DecimalRangeField.errors
+      ~DecimalRangeField.process_errors
+      ~DecimalRangeField.raw_data
+      ~DecimalRangeField.validators
       ~DecimalRangeField.widget
 
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~DecimalRangeField.__call__
+      ~DecimalRangeField.check_validators
+      ~DecimalRangeField.gettext
+      ~DecimalRangeField.ngettext
+      ~DecimalRangeField.populate_obj
+      ~DecimalRangeField.post_validate
+      ~DecimalRangeField.pre_validate
+      ~DecimalRangeField.process
+      ~DecimalRangeField.process_data
+      ~DecimalRangeField.process_formdata
+      ~DecimalRangeField.validate
+
    .. rubric:: Attributes Documentation
 
+   .. autoattribute:: do_not_call_in_templates
+   .. autoattribute:: errors
+   .. autoattribute:: process_errors
+   .. autoattribute:: raw_data
+   .. autoattribute:: validators
    .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: __call__
+   .. automethod:: check_validators
+   .. automethod:: gettext
+   .. automethod:: ngettext
+   .. automethod:: populate_obj
+   .. automethod:: post_validate
+   .. automethod:: pre_validate
+   .. automethod:: process
+   .. automethod:: process_data
+   .. automethod:: process_formdata
+   .. automethod:: validate