From fe56f4a00941aed2eb1c10cf618cc66dfe939771 Mon Sep 17 00:00:00 2001 From: Dzmitry Hramyka Date: Mon, 13 Nov 2023 16:59:52 +0100 Subject: [PATCH] fix: Documentation of APIs (#201) (#206) --- docs/api_api_v1.rst | 10 +++++----- docs/api_internal.rst | 2 +- docs/api_models.rst | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api_api_v1.rst b/docs/api_api_v1.rst index fcac616a..4c5e39d0 100644 --- a/docs/api_api_v1.rst +++ b/docs/api_api_v1.rst @@ -10,7 +10,7 @@ app.api.api_v1 app.api.api_v1.endpoints.adminmsgs ---------------------------------- -.. automodule:: app.api.api_v1.endpoints.adminmsgs +.. automodule:: backend.app.api.api_v1.endpoints.adminmsgs :members: :undoc-members: :show-inheritance: @@ -20,7 +20,7 @@ app.api.api_v1.endpoints.adminmsgs app.api.api_v1.endpoints.auth ----------------------------- -.. automodule:: app.api.api_v1.endpoints.auth +.. automodule:: backend.app.api.api_v1.endpoints.auth :members: :undoc-members: :show-inheritance: @@ -30,7 +30,7 @@ app.api.api_v1.endpoints.auth app.api.api_v1.endpoints.bookmarks ---------------------------------- -.. automodule:: app.api.api_v1.endpoints.bookmarks +.. automodule:: backend.app.api.api_v1.endpoints.bookmarks :members: :undoc-members: :show-inheritance: @@ -40,7 +40,7 @@ app.api.api_v1.endpoints.bookmarks app.api.api_v1.endpoints.caseinfo --------------------------------- -.. automodule:: app.api.api_v1.endpoints.caseinfo +.. automodule:: backend.app.api.api_v1.endpoints.caseinfo :members: :undoc-members: :show-inheritance: @@ -50,7 +50,7 @@ app.api.api_v1.endpoints.caseinfo app.api.api_v1.endpoints.utils ------------------------------ -.. automodule:: app.api.api_v1.endpoints.utils +.. automodule:: backend.app.api.api_v1.endpoints.utils :members: :undoc-members: :show-inheritance: diff --git a/docs/api_internal.rst b/docs/api_internal.rst index 0a880672..33dd8211 100644 --- a/docs/api_internal.rst +++ b/docs/api_internal.rst @@ -10,7 +10,7 @@ app.api.internal app.api.internal.endpoints.remote --------------------------------- -.. automodule:: app.api.internal.endpoints.remote +.. automodule:: backend.app.api.internal.endpoints.remote :members: :undoc-members: :show-inheritance: diff --git a/docs/api_models.rst b/docs/api_models.rst index 7ebe3938..1c8fa378 100644 --- a/docs/api_models.rst +++ b/docs/api_models.rst @@ -10,26 +10,26 @@ app.models app.models.adminmsg ------------------- -.. automodule:: app.models.adminmsg +.. automodule:: backend.app.models.adminmsg :members: ------------------- app.models.bookmark ------------------- -.. automodule:: app.models.bookmark +.. automodule:: backend.app.models.bookmark :members: --------------- app.models.user --------------- -.. automodule:: app.models.user +.. automodule:: backend.app.models.user :members: ------------------- app.models.caseinfo ------------------- -.. automodule:: app.models.caseinfo +.. automodule:: backend.app.models.caseinfo :members: