diff --git a/docs/source/contrib.rst b/docs/source/contrib.rst index 0d93afe..cb46266 100644 --- a/docs/source/contrib.rst +++ b/docs/source/contrib.rst @@ -9,85 +9,9 @@ If you want to install this package with support for all CONTRIB packages, you c >>> pip install balderhub-html[all] -Contrib for ``balderhub-auth`` -============================== -For activating this module, you need to install the package like shown below +.. toctree:: + :caption: Contributions -.. code-block:: none - - >>> pip install balderhub-html[auth] - -Once installed you can use it. - -Pages ------ - -.. autoclass:: balderhub.html.contrib.auth.pages.LoginPage - :members: - - -Setup Features --------------- - -.. autoclass:: balderhub.html.contrib.auth.setup_features.UserLoginFeature - :members: - - -Contrib for ``balderhub-crud`` -============================== - -For activating this module, you need to install the package like shown below - -.. code-block:: none - - >>> pip install balderhub-html[crud] - -Once installed you can use it. - -Field Callbacks ---------------- - -This BalderHub project provides field callbacks for almost every normal HTML element, that is provided by this package. -You can use it right away. - - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldCollectorCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldFillerCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxCollectorFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxFillerFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputCollectorFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputFillerFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectCollectorFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectFillerFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.TextCollectorFieldCallback - :members: - -.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.ValueFromUrlCollectorFieldCallback - :members: - - -Field Callbacks Auto-Select Functions -------------------------------------- - -This package does also provide functions to auto select the correct callback based on the given html element. - -.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_collector_callback_type_for - -.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_filler_callback_type_for + contrib/auth.rst + contrib/crud.rst diff --git a/docs/source/contrib/auth.rst b/docs/source/contrib/auth.rst new file mode 100644 index 0000000..16402a5 --- /dev/null +++ b/docs/source/contrib/auth.rst @@ -0,0 +1,23 @@ +Contrib for ``balderhub-auth`` +****************************** + +For activating this module, you need to install the package like shown below + +.. code-block:: none + + >>> pip install balderhub-html[auth] + +Once installed you can use it. + +Pages +===== + +.. autoclass:: balderhub.html.contrib.auth.pages.LoginPage + :members: + + +Setup Features +============== + +.. autoclass:: balderhub.html.contrib.auth.setup_features.UserLoginFeature + :members: \ No newline at end of file diff --git a/docs/source/contrib/crud.rst b/docs/source/contrib/crud.rst new file mode 100644 index 0000000..2a0a173 --- /dev/null +++ b/docs/source/contrib/crud.rst @@ -0,0 +1,57 @@ +Contrib for ``balderhub-crud`` +****************************** + +For activating this module, you need to install the package like shown below + +.. code-block:: none + + >>> pip install balderhub-html[crud] + +Once installed you can use it. + +Field Callbacks +=============== + +This BalderHub project provides field callbacks for almost every normal HTML element, that is provided by this package. +You can use it right away. + + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldCollectorCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldFillerCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxCollectorFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxFillerFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputCollectorFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputFillerFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectCollectorFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectFillerFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.TextCollectorFieldCallback + :members: + +.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.ValueFromUrlCollectorFieldCallback + :members: + + +Field Callbacks Auto-Select Functions +===================================== + +This package does also provide functions to auto select the correct callback based on the given html element. + +.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_collector_callback_type_for + +.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_filler_callback_type_for