From 59795635eee8580c20d4f39c0bbf2ed37d2990df Mon Sep 17 00:00:00 2001 From: imacat Date: Tue, 7 Feb 2023 11:41:28 +0800 Subject: [PATCH] Updated the Sphinx documentation. --- docs/source/accounting.account.rst | 53 +++++++++++++++++++++++++ docs/source/accounting.base_account.rst | 14 ++----- docs/source/accounting.currency.rst | 53 +++++++++++++++++++++++++ docs/source/accounting.rst | 18 +++++++++ docs/source/accounting.utils.rst | 32 +++++++++++++++ 5 files changed, 159 insertions(+), 11 deletions(-) create mode 100644 docs/source/accounting.account.rst create mode 100644 docs/source/accounting.currency.rst diff --git a/docs/source/accounting.account.rst b/docs/source/accounting.account.rst new file mode 100644 index 0000000..23164ca --- /dev/null +++ b/docs/source/accounting.account.rst @@ -0,0 +1,53 @@ +accounting.account package +========================== + +Submodules +---------- + +accounting.account.commands module +---------------------------------- + +.. automodule:: accounting.account.commands + :members: + :undoc-members: + :show-inheritance: + +accounting.account.converters module +------------------------------------ + +.. automodule:: accounting.account.converters + :members: + :undoc-members: + :show-inheritance: + +accounting.account.forms module +------------------------------- + +.. automodule:: accounting.account.forms + :members: + :undoc-members: + :show-inheritance: + +accounting.account.query module +------------------------------- + +.. automodule:: accounting.account.query + :members: + :undoc-members: + :show-inheritance: + +accounting.account.views module +------------------------------- + +.. automodule:: accounting.account.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.base_account.rst b/docs/source/accounting.base_account.rst index 5c7cb44..3bbf2f5 100644 --- a/docs/source/accounting.base_account.rst +++ b/docs/source/accounting.base_account.rst @@ -12,18 +12,10 @@ accounting.base\_account.commands module :undoc-members: :show-inheritance: -accounting.base\_account.database module ----------------------------------------- +accounting.base\_account.converters module +------------------------------------------ -.. automodule:: accounting.base_account.database - :members: - :undoc-members: - :show-inheritance: - -accounting.base\_account.models module --------------------------------------- - -.. automodule:: accounting.base_account.models +.. automodule:: accounting.base_account.converters :members: :undoc-members: :show-inheritance: diff --git a/docs/source/accounting.currency.rst b/docs/source/accounting.currency.rst new file mode 100644 index 0000000..9bdda6b --- /dev/null +++ b/docs/source/accounting.currency.rst @@ -0,0 +1,53 @@ +accounting.currency package +=========================== + +Submodules +---------- + +accounting.currency.commands module +----------------------------------- + +.. automodule:: accounting.currency.commands + :members: + :undoc-members: + :show-inheritance: + +accounting.currency.converters module +------------------------------------- + +.. automodule:: accounting.currency.converters + :members: + :undoc-members: + :show-inheritance: + +accounting.currency.forms module +-------------------------------- + +.. automodule:: accounting.currency.forms + :members: + :undoc-members: + :show-inheritance: + +accounting.currency.query module +-------------------------------- + +.. automodule:: accounting.currency.query + :members: + :undoc-members: + :show-inheritance: + +accounting.currency.views module +-------------------------------- + +.. automodule:: accounting.currency.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.currency + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.rst b/docs/source/accounting.rst index b806e9c..86acafd 100644 --- a/docs/source/accounting.rst +++ b/docs/source/accounting.rst @@ -7,12 +7,22 @@ Subpackages .. toctree:: :maxdepth: 4 + accounting.account accounting.base_account + accounting.currency accounting.utils Submodules ---------- +accounting.database module +-------------------------- + +.. automodule:: accounting.database + :members: + :undoc-members: + :show-inheritance: + accounting.locale module ------------------------ @@ -21,6 +31,14 @@ accounting.locale module :undoc-members: :show-inheritance: +accounting.models module +------------------------ + +.. automodule:: accounting.models + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/accounting.utils.rst b/docs/source/accounting.utils.rst index 1a2d854..ec625ad 100644 --- a/docs/source/accounting.utils.rst +++ b/docs/source/accounting.utils.rst @@ -4,6 +4,14 @@ accounting.utils package Submodules ---------- +accounting.utils.next\_url module +--------------------------------- + +.. automodule:: accounting.utils.next_url + :members: + :undoc-members: + :show-inheritance: + accounting.utils.pagination module ---------------------------------- @@ -28,6 +36,30 @@ accounting.utils.query module :undoc-members: :show-inheritance: +accounting.utils.random\_id module +---------------------------------- + +.. automodule:: accounting.utils.random_id + :members: + :undoc-members: + :show-inheritance: + +accounting.utils.strip\_text module +----------------------------------- + +.. automodule:: accounting.utils.strip_text + :members: + :undoc-members: + :show-inheritance: + +accounting.utils.user module +---------------------------- + +.. automodule:: accounting.utils.user + :members: + :undoc-members: + :show-inheritance: + Module contents ---------------