From 10e8add9e6f122ab8383768006985067589c90f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Wed, 7 Dec 2022 18:11:35 +0800 Subject: [PATCH] Replaced the manually-added package content with the automatically-generated package content, and added the modules list to the documentation. --- docs/source/flask_digest_auth.rst | 49 +++++++++++++++++++------------ docs/source/index.rst | 1 + docs/source/intro.rst | 8 ++--- docs/source/modules.rst | 7 +++++ 4 files changed, 43 insertions(+), 22 deletions(-) create mode 100644 docs/source/modules.rst diff --git a/docs/source/flask_digest_auth.rst b/docs/source/flask_digest_auth.rst index c839ed1..0d005d5 100644 --- a/docs/source/flask_digest_auth.rst +++ b/docs/source/flask_digest_auth.rst @@ -1,24 +1,37 @@ flask\_digest\_auth package =========================== -The ``DigestAuth`` Class ------------------------- -.. autoclass:: flask_digest_auth.DigestAuth - :members: - :undoc-members: - :show-inheritance: +Submodules +---------- -The ``make_password_hash`` Function ------------------------------------ -.. autofunction:: flask_digest_auth.make_password_hash +flask\_digest\_auth.algo module +------------------------------- -The ``calc_response`` Function ------------------------------- -.. autofunction:: flask_digest_auth.calc_response +.. automodule:: flask_digest_auth.algo + :members: + :undoc-members: + :show-inheritance: -The ``Client`` Test Class -------------------------- -.. autoclass:: flask_digest_auth.Client - :members: - :undoc-members: - :show-inheritance: +flask\_digest\_auth.auth module +------------------------------- + +.. 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: diff --git a/docs/source/index.rst b/docs/source/index.rst index ce84e15..3fe1c6a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,6 +26,7 @@ Indices and tables ================== * :ref:`genindex` +* :ref:`modindex` * :ref:`search` .. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication diff --git a/docs/source/intro.rst b/docs/source/intro.rst index f8b5b58..d5eeb5d 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -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`. diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..1475ab1 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + flask_digest_auth