imacat/flask-digestauth
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 15 Wiki Activity

Replaced the manually-added package content with the automatically-generated package content, and added the modules list to the documentation.

Browse Source
This commit is contained in:
依瑪貓 2022-12-07 18:11:35 +08:00
parent c004e28c37
commit 10e8add9e6
4 changed files with 43 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/source/flask_digest_auth.rst
View File

@ -1,24 +1,37 @@
flask\_digest\_auth package flask\_digest\_auth package
=========================== ===========================
The ``DigestAuth`` Class Submodules
------------------------ ----------
.. autoclass:: flask_digest_auth.DigestAuth
:members:
:undoc-members:
:show-inheritance:
The ``make_password_hash`` Function flask\_digest\_auth.algo module
----------------------------------- -------------------------------
.. autofunction:: flask_digest_auth.make_password_hash
The ``calc_response`` Function .. automodule:: flask_digest_auth.algo
------------------------------ :members:
.. autofunction:: flask_digest_auth.calc_response :undoc-members:
:show-inheritance:
The ``Client`` Test Class flask\_digest\_auth.auth module
------------------------- -------------------------------
.. autoclass:: flask_digest_auth.Client
:members: .. automodule:: flask_digest_auth.auth
:undoc-members: :members:
:show-inheritance: :undoc-members:
:show-inheritance:
flask\_digest\_auth.test module
-------------------------------
.. automodule:: flask_digest_auth.test
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: flask_digest_auth
:members:
:undoc-members:
:show-inheritance:

1
docs/source/index.rst
View File

@ -26,6 +26,7 @@ Indices and tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex`
* :ref:`search` * :ref:`search`
.. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication .. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication

8
docs/source/intro.rst
View File

@ -63,7 +63,7 @@ The username is part of the hash. If the user changes their username,
you need to ask their password, to generate and store the new password you need to ask their password, to generate and store the new password
hash. hash.
See :meth:`flask_digest_auth.make_password_hash`. See :func:`flask_digest_auth.algo.make_password_hash`.
Flask-Digest-Auth Alone Flask-Digest-Auth Alone
@ -118,7 +118,7 @@ logging the log in event, adding the log in counter, etc.
def on_login(user: User) -> None: def on_login(user: User) -> None:
user.visits = user.visits + 1 user.visits = user.visits + 1
See :meth:`flask_digest_auth.DigestAuth.register_on_login`. See :meth:`flask_digest_auth.auth.DigestAuth.register_on_login`.
Log Out Log Out
@ -127,7 +127,7 @@ Log Out
Flask-Digest-Auth supports log out. The user will be prompted for the Flask-Digest-Auth supports log out. The user will be prompted for the
new username and password. new username and password.
See :meth:`flask_digest_auth.DigestAuth.logout`. See :meth:`flask_digest_auth.auth.DigestAuth.logout`.
Test Client Test Client
@ -136,7 +136,7 @@ Test Client
Flask-Digest-Auth comes with a test client that supports HTTP digest Flask-Digest-Auth comes with a test client that supports HTTP digest
authentication. authentication.
See :class:`flask_digest_auth.Client`. See :class:`flask_digest_auth.test.Client`.
Also see :ref:`example-unittest` and :ref:`example-pytest`. Also see :ref:`example-unittest` and :ref:`example-pytest`.

7
docs/source/modules.rst Normal file
View File

@ -0,0 +1,7 @@
src
===
.. toctree::
:maxdepth: 4
flask_digest_auth