From 54d36ccf3630858a781f39a2dea373c49834182c Mon Sep 17 00:00:00 2001 From: Evgeniy Alekseev Date: Mon, 10 Apr 2023 21:13:43 +0300 Subject: [PATCH] docs update --- docs/ahriman.web.rst | 17 ++++ docs/ahriman.web.schemas.rst | 165 +++++++++++++++++++++++++++++++++ docs/ahriman.web.views.api.rst | 29 ++++++ docs/ahriman.web.views.rst | 1 + 4 files changed, 212 insertions(+) create mode 100644 docs/ahriman.web.schemas.rst create mode 100644 docs/ahriman.web.views.api.rst diff --git a/docs/ahriman.web.rst b/docs/ahriman.web.rst index 20706214..a2641675 100644 --- a/docs/ahriman.web.rst +++ b/docs/ahriman.web.rst @@ -8,11 +8,28 @@ Subpackages :maxdepth: 4 ahriman.web.middlewares + ahriman.web.schemas ahriman.web.views Submodules ---------- +ahriman.web.apispec module +-------------------------- + +.. automodule:: ahriman.web.apispec + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.cors module +----------------------- + +.. automodule:: ahriman.web.cors + :members: + :no-undoc-members: + :show-inheritance: + ahriman.web.routes module ------------------------- diff --git a/docs/ahriman.web.schemas.rst b/docs/ahriman.web.schemas.rst new file mode 100644 index 00000000..923bc1c9 --- /dev/null +++ b/docs/ahriman.web.schemas.rst @@ -0,0 +1,165 @@ +ahriman.web.schemas package +=========================== + +Submodules +---------- + +ahriman.web.schemas.aur\_package\_schema module +----------------------------------------------- + +.. automodule:: ahriman.web.schemas.aur_package_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.auth\_schema module +--------------------------------------- + +.. automodule:: ahriman.web.schemas.auth_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.counters\_schema module +------------------------------------------- + +.. automodule:: ahriman.web.schemas.counters_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.error\_schema module +---------------------------------------- + +.. automodule:: ahriman.web.schemas.error_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.internal\_status\_schema module +--------------------------------------------------- + +.. automodule:: ahriman.web.schemas.internal_status_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.log\_schema module +-------------------------------------- + +.. automodule:: ahriman.web.schemas.log_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.login\_schema module +---------------------------------------- + +.. automodule:: ahriman.web.schemas.login_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.logs\_schema module +--------------------------------------- + +.. automodule:: ahriman.web.schemas.logs_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.oauth2\_schema module +----------------------------------------- + +.. automodule:: ahriman.web.schemas.oauth2_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.package\_name\_schema module +------------------------------------------------ + +.. automodule:: ahriman.web.schemas.package_name_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.package\_names\_schema module +------------------------------------------------- + +.. automodule:: ahriman.web.schemas.package_names_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.package\_properties\_schema module +------------------------------------------------------ + +.. automodule:: ahriman.web.schemas.package_properties_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.package\_schema module +------------------------------------------ + +.. automodule:: ahriman.web.schemas.package_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.package\_status\_schema module +-------------------------------------------------- + +.. automodule:: ahriman.web.schemas.package_status_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.pgp\_key\_id\_schema module +----------------------------------------------- + +.. automodule:: ahriman.web.schemas.pgp_key_id_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.pgp\_key\_schema module +------------------------------------------- + +.. automodule:: ahriman.web.schemas.pgp_key_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.remote\_schema module +----------------------------------------- + +.. automodule:: ahriman.web.schemas.remote_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.search\_schema module +----------------------------------------- + +.. automodule:: ahriman.web.schemas.search_schema + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.schemas.status\_schema module +----------------------------------------- + +.. automodule:: ahriman.web.schemas.status_schema + :members: + :no-undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ahriman.web.schemas + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/ahriman.web.views.api.rst b/docs/ahriman.web.views.api.rst new file mode 100644 index 00000000..e12a5c7b --- /dev/null +++ b/docs/ahriman.web.views.api.rst @@ -0,0 +1,29 @@ +ahriman.web.views.api package +============================= + +Submodules +---------- + +ahriman.web.views.api.docs module +--------------------------------- + +.. automodule:: ahriman.web.views.api.docs + :members: + :no-undoc-members: + :show-inheritance: + +ahriman.web.views.api.swagger module +------------------------------------ + +.. automodule:: ahriman.web.views.api.swagger + :members: + :no-undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: ahriman.web.views.api + :members: + :no-undoc-members: + :show-inheritance: diff --git a/docs/ahriman.web.views.rst b/docs/ahriman.web.views.rst index 35811299..ccd4a8ee 100644 --- a/docs/ahriman.web.views.rst +++ b/docs/ahriman.web.views.rst @@ -7,6 +7,7 @@ Subpackages .. toctree:: :maxdepth: 4 + ahriman.web.views.api ahriman.web.views.service ahriman.web.views.status ahriman.web.views.user