Merge pull request #2 from alexrudy:docs

Documentation
alexrudy · Mar 25, 2024 · 16a78d1 · 16a78d1
2 parents 3568f43 + 3502c4a
commit 16a78d1
Show file tree

Hide file tree

Showing 102 changed files with 1,871 additions and 39 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = .
+SOURCEDIR     = .
+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
@@ -0,0 +1,31 @@
+BooleanField
+============
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: BooleanField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~BooleanField.false_values
+      ~BooleanField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~BooleanField.process_data
+      ~BooleanField.process_formdata
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: false_values
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: process_data
+   .. automethod:: process_formdata
diff --git a/docs/api/bootlace.forms.fields.ColorField.rst b/docs/api/bootlace.forms.fields.ColorField.rst
@@ -0,0 +1,17 @@
+ColorField
+==========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: ColorField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~ColorField.widget
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
diff --git a/docs/api/bootlace.forms.fields.DateField.rst b/docs/api/bootlace.forms.fields.DateField.rst
@@ -0,0 +1,27 @@
+DateField
+=========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: DateField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~DateField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~DateField.process_formdata
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: process_formdata
diff --git a/docs/api/bootlace.forms.fields.DateTimeField.rst b/docs/api/bootlace.forms.fields.DateTimeField.rst
@@ -0,0 +1,27 @@
+DateTimeField
+=============
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: DateTimeField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~DateTimeField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~DateTimeField.process_formdata
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: process_formdata
diff --git a/docs/api/bootlace.forms.fields.DateTimeLocalField.rst b/docs/api/bootlace.forms.fields.DateTimeLocalField.rst
@@ -0,0 +1,17 @@
+DateTimeLocalField
+==================
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: DateTimeLocalField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~DateTimeLocalField.widget
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
diff --git a/docs/api/bootlace.forms.fields.DecimalField.rst b/docs/api/bootlace.forms.fields.DecimalField.rst
@@ -0,0 +1,27 @@
+DecimalField
+============
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: DecimalField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~DecimalField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~DecimalField.process_formdata
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: process_formdata
diff --git a/docs/api/bootlace.forms.fields.DecimalRangeField.rst b/docs/api/bootlace.forms.fields.DecimalRangeField.rst
@@ -0,0 +1,17 @@
+DecimalRangeField
+=================
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: DecimalRangeField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~DecimalRangeField.widget
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
diff --git a/docs/api/bootlace.forms.fields.EmailField.rst b/docs/api/bootlace.forms.fields.EmailField.rst
@@ -0,0 +1,17 @@
+EmailField
+==========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: EmailField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~EmailField.widget
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
diff --git a/docs/api/bootlace.forms.fields.EnumField.rst b/docs/api/bootlace.forms.fields.EnumField.rst
@@ -0,0 +1,7 @@
+EnumField
+=========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: EnumField
+   :show-inheritance:
diff --git a/docs/api/bootlace.forms.fields.Field.rst b/docs/api/bootlace.forms.fields.Field.rst
@@ -0,0 +1,57 @@
+Field
+=====
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: Field
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Field.do_not_call_in_templates
+      ~Field.errors
+      ~Field.process_errors
+      ~Field.raw_data
+      ~Field.validators
+      ~Field.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Field.__call__
+      ~Field.check_validators
+      ~Field.gettext
+      ~Field.ngettext
+      ~Field.populate_obj
+      ~Field.post_validate
+      ~Field.pre_validate
+      ~Field.process
+      ~Field.process_data
+      ~Field.process_formdata
+      ~Field.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.FieldList.rst b/docs/api/bootlace.forms.fields.FieldList.rst
@@ -0,0 +1,37 @@
+FieldList
+=========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: FieldList
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~FieldList.data
+      ~FieldList.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~FieldList.append_entry
+      ~FieldList.pop_entry
+      ~FieldList.populate_obj
+      ~FieldList.process
+      ~FieldList.validate
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: data
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: append_entry
+   .. automethod:: pop_entry
+   .. automethod:: populate_obj
+   .. automethod:: process
+   .. automethod:: validate
diff --git a/docs/api/bootlace.forms.fields.FileField.rst b/docs/api/bootlace.forms.fields.FileField.rst
@@ -0,0 +1,17 @@
+FileField
+=========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: FileField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~FileField.widget
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
diff --git a/docs/api/bootlace.forms.fields.Flags.rst b/docs/api/bootlace.forms.fields.Flags.rst
@@ -0,0 +1,7 @@
+Flags
+=====
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: Flags
+   :show-inheritance:
diff --git a/docs/api/bootlace.forms.fields.FloatField.rst b/docs/api/bootlace.forms.fields.FloatField.rst
@@ -0,0 +1,27 @@
+FloatField
+==========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: FloatField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~FloatField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~FloatField.process_formdata
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: process_formdata
diff --git a/docs/api/bootlace.forms.fields.FormField.rst b/docs/api/bootlace.forms.fields.FormField.rst
@@ -0,0 +1,35 @@
+FormField
+=========
+
+.. currentmodule:: bootlace.forms.fields
+
+.. autoclass:: FormField
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~FormField.data
+      ~FormField.errors
+      ~FormField.widget
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~FormField.populate_obj
+      ~FormField.process
+      ~FormField.validate
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: data
+   .. autoattribute:: errors
+   .. autoattribute:: widget
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: populate_obj
+   .. automethod:: process
+   .. automethod:: validate