Replaced the manually-added package content with the automatically-generated package content, and added the modules list to the documentation.
This commit is contained in:
parent
c004e28c37
commit
10e8add9e6
@ -1,24 +1,37 @@
|
||||
flask\_digest\_auth package
|
||||
===========================
|
||||
|
||||
The ``DigestAuth`` Class
|
||||
------------------------
|
||||
.. autoclass:: flask_digest_auth.DigestAuth
|
||||
Submodules
|
||||
----------
|
||||
|
||||
flask\_digest\_auth.algo module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: flask_digest_auth.algo
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
The ``make_password_hash`` Function
|
||||
-----------------------------------
|
||||
.. autofunction:: flask_digest_auth.make_password_hash
|
||||
flask\_digest\_auth.auth module
|
||||
-------------------------------
|
||||
|
||||
The ``calc_response`` Function
|
||||
------------------------------
|
||||
.. autofunction:: flask_digest_auth.calc_response
|
||||
|
||||
The ``Client`` Test Class
|
||||
-------------------------
|
||||
.. autoclass:: flask_digest_auth.Client
|
||||
.. automodule:: flask_digest_auth.auth
|
||||
:members:
|
||||
: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:
|
||||
|
@ -26,6 +26,7 @@ Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication
|
||||
|
@ -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
|
||||
hash.
|
||||
|
||||
See :meth:`flask_digest_auth.make_password_hash`.
|
||||
See :func:`flask_digest_auth.algo.make_password_hash`.
|
||||
|
||||
|
||||
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:
|
||||
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
|
||||
@ -127,7 +127,7 @@ Log Out
|
||||
Flask-Digest-Auth supports log out. The user will be prompted for the
|
||||
new username and password.
|
||||
|
||||
See :meth:`flask_digest_auth.DigestAuth.logout`.
|
||||
See :meth:`flask_digest_auth.auth.DigestAuth.logout`.
|
||||
|
||||
|
||||
Test Client
|
||||
@ -136,7 +136,7 @@ Test Client
|
||||
Flask-Digest-Auth comes with a test client that supports HTTP digest
|
||||
authentication.
|
||||
|
||||
See :class:`flask_digest_auth.Client`.
|
||||
See :class:`flask_digest_auth.test.Client`.
|
||||
|
||||
Also see :ref:`example-unittest` and :ref:`example-pytest`.
|
||||
|
||||
|
7
docs/source/modules.rst
Normal file
7
docs/source/modules.rst
Normal file
@ -0,0 +1,7 @@
|
||||
src
|
||||
===
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
flask_digest_auth
|
Loading…
Reference in New Issue
Block a user