From 3a708b304319afe84ebf3d40ecebabe6acc339f3 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Mon, 7 Jun 2021 13:59:08 +0530 Subject: started work on automatic documentation --- .../html/_sources/autoapi/app/models/index.rst.txt | 99 ++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 docs/_build/html/_sources/autoapi/app/models/index.rst.txt (limited to 'docs/_build/html/_sources/autoapi/app/models/index.rst.txt') diff --git a/docs/_build/html/_sources/autoapi/app/models/index.rst.txt b/docs/_build/html/_sources/autoapi/app/models/index.rst.txt new file mode 100644 index 0000000..f425142 --- /dev/null +++ b/docs/_build/html/_sources/autoapi/app/models/index.rst.txt @@ -0,0 +1,99 @@ +:mod:`app.models` +================= + +.. py:module:: app.models + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + app.models.User + + + + +.. class:: User + + Bases: :py:obj:`app.db.Model`, :py:obj:`flask_login.UserMixin` + + This provides default implementations for the methods that Flask-Login + expects user objects to have. + + .. attribute:: __tablename__ + :annotation: = users + + + + .. attribute:: first_name + + + + + .. attribute:: last_name + + + + + .. attribute:: email + + + + + .. attribute:: confirmation + + + + + .. attribute:: paid + + + + + .. attribute:: role + + + + + .. attribute:: team + + + + + .. attribute:: login_type + + + + + .. attribute:: _password + + + + + .. method:: full_name(self) + :property: + + + .. method:: password(self) + + + .. method:: check_password(self, plaintext) + + + .. method:: get_id(self) + + + .. method:: get_role(self) + + + .. method:: get_team(self) + + + .. method:: is_paid(self) + + + -- cgit v1.2.3