Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #2

Merged
merged 3 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
31 changes: 31 additions & 0 deletions docs/api/bootlace.forms.fields.BooleanField.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/api/bootlace.forms.fields.ColorField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
ColorField
==========

.. currentmodule:: bootlace.forms.fields

.. autoclass:: ColorField
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~ColorField.widget

.. rubric:: Attributes Documentation

.. autoattribute:: widget
27 changes: 27 additions & 0 deletions docs/api/bootlace.forms.fields.DateField.rst
Original file line number Diff line number Diff line change
@@ -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
27 changes: 27 additions & 0 deletions docs/api/bootlace.forms.fields.DateTimeField.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/api/bootlace.forms.fields.DateTimeLocalField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
DateTimeLocalField
==================

.. currentmodule:: bootlace.forms.fields

.. autoclass:: DateTimeLocalField
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~DateTimeLocalField.widget

.. rubric:: Attributes Documentation

.. autoattribute:: widget
27 changes: 27 additions & 0 deletions docs/api/bootlace.forms.fields.DecimalField.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/api/bootlace.forms.fields.DecimalRangeField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
DecimalRangeField
=================

.. currentmodule:: bootlace.forms.fields

.. autoclass:: DecimalRangeField
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~DecimalRangeField.widget

.. rubric:: Attributes Documentation

.. autoattribute:: widget
17 changes: 17 additions & 0 deletions docs/api/bootlace.forms.fields.EmailField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
EmailField
==========

.. currentmodule:: bootlace.forms.fields

.. autoclass:: EmailField
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~EmailField.widget

.. rubric:: Attributes Documentation

.. autoattribute:: widget
7 changes: 7 additions & 0 deletions docs/api/bootlace.forms.fields.EnumField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
EnumField
=========

.. currentmodule:: bootlace.forms.fields

.. autoclass:: EnumField
:show-inheritance:
57 changes: 57 additions & 0 deletions docs/api/bootlace.forms.fields.Field.rst
Original file line number Diff line number Diff line change
@@ -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
37 changes: 37 additions & 0 deletions docs/api/bootlace.forms.fields.FieldList.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/api/bootlace.forms.fields.FileField.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FileField
=========

.. currentmodule:: bootlace.forms.fields

.. autoclass:: FileField
:show-inheritance:

.. rubric:: Attributes Summary

.. autosummary::

~FileField.widget

.. rubric:: Attributes Documentation

.. autoattribute:: widget
7 changes: 7 additions & 0 deletions docs/api/bootlace.forms.fields.Flags.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Flags
=====

.. currentmodule:: bootlace.forms.fields

.. autoclass:: Flags
:show-inheritance:
27 changes: 27 additions & 0 deletions docs/api/bootlace.forms.fields.FloatField.rst
Original file line number Diff line number Diff line change
@@ -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
35 changes: 35 additions & 0 deletions docs/api/bootlace.forms.fields.FormField.rst
Original file line number Diff line number Diff line change
@@ -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
Loading
Loading