From d099fe40a0bc0d74b7fc88cd6f44dce92876d511 Mon Sep 17 00:00:00 2001 From: Valentin Samir Date: Tue, 2 Aug 2016 15:15:51 +0200 Subject: [PATCH] Document cas_server/templatetags --- cas_server/templatetags/cas_server.py | 25 +++++++++++++++++++ docs/package/cas_server.rst | 7 ++++++ .../cas_server.templatetags.cas_server.rst | 7 ++++++ docs/package/cas_server.templatetags.rst | 17 +++++++++++++ docs/package/cas_server.urls.rst | 7 ++++++ 5 files changed, 63 insertions(+) create mode 100644 docs/package/cas_server.templatetags.cas_server.rst create mode 100644 docs/package/cas_server.templatetags.rst create mode 100644 docs/package/cas_server.urls.rst diff --git a/cas_server/templatetags/cas_server.py b/cas_server/templatetags/cas_server.py index ec2839e..76e53de 100644 --- a/cas_server/templatetags/cas_server.py +++ b/cas_server/templatetags/cas_server.py @@ -1,3 +1,14 @@ +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License version 3 for +# more details. +# +# You should have received a copy of the GNU General Public License version 3 +# along with this program; if not, write to the Free Software Foundation, Inc., 51 +# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# +# (c) 2015-2016 Valentin Samir +"""template tags for the app""" from django import template from django import forms @@ -6,9 +17,23 @@ register = template.Library() @register.filter(name='is_checkbox') def is_checkbox(field): + """ + check is a form bound field is a checkbox + + :param django.forms.boundfield.BoundField field: A bound field + :return: ``True`` if the field is a checkbox, ``False`` otherwise. + :rtype: bool + """ return isinstance(field.field.widget, forms.CheckboxInput) @register.filter(name='is_hidden') def is_hidden(field): + """ + check is a form bound field is hidden + + :param django.forms.boundfield.BoundField field: A bound field + :return: ``True`` if the field is hidden, ``False`` otherwise. + :rtype: bool + """ return isinstance(field.field.widget, forms.HiddenInput) diff --git a/docs/package/cas_server.rst b/docs/package/cas_server.rst index 62c00c4..09f3daf 100644 --- a/docs/package/cas_server.rst +++ b/docs/package/cas_server.rst @@ -1,6 +1,13 @@ cas_server package ================== +Subpackages +----------- + +.. toctree:: + + cas_server.templatetags + Submodules ---------- diff --git a/docs/package/cas_server.templatetags.cas_server.rst b/docs/package/cas_server.templatetags.cas_server.rst new file mode 100644 index 0000000..eb4da8a --- /dev/null +++ b/docs/package/cas_server.templatetags.cas_server.rst @@ -0,0 +1,7 @@ +cas_server.templatetags.cas_server module +========================================= + +.. automodule:: cas_server.templatetags.cas_server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/package/cas_server.templatetags.rst b/docs/package/cas_server.templatetags.rst new file mode 100644 index 0000000..9c49c77 --- /dev/null +++ b/docs/package/cas_server.templatetags.rst @@ -0,0 +1,17 @@ +cas_server.templatetags package +=============================== + +Submodules +---------- + +.. toctree:: + + cas_server.templatetags.cas_server + +Module contents +--------------- + +.. automodule:: cas_server.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/package/cas_server.urls.rst b/docs/package/cas_server.urls.rst new file mode 100644 index 0000000..5127b5a --- /dev/null +++ b/docs/package/cas_server.urls.rst @@ -0,0 +1,7 @@ +cas_server.urls module +====================== + +.. automodule:: cas_server.urls + :members: + :undoc-members: + :show-inheritance: