From d7bc01ccb4b8e697ed1228499911fc3145f4377d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Thu, 9 Mar 2023 14:38:45 +0800 Subject: [PATCH] Updated the Sphinx documentation. --- docs/source/accounting.account.rst | 6 +- docs/source/accounting.base_account.rst | 6 +- docs/source/accounting.currency.rst | 6 +- docs/source/accounting.report.reports.rst | 77 +++++++++++++++++++ .../accounting.report.reports.utils.rst | 77 +++++++++++++++++++ docs/source/accounting.report.rst | 61 +++++++++++++++ docs/source/accounting.rst | 17 ++++ docs/source/accounting.transaction.rst | 24 ++---- docs/source/accounting.utils.rst | 8 ++ 9 files changed, 257 insertions(+), 25 deletions(-) create mode 100644 docs/source/accounting.report.reports.rst create mode 100644 docs/source/accounting.report.reports.utils.rst create mode 100644 docs/source/accounting.report.rst diff --git a/docs/source/accounting.account.rst b/docs/source/accounting.account.rst index 23164ca..6cf2c4e 100644 --- a/docs/source/accounting.account.rst +++ b/docs/source/accounting.account.rst @@ -28,10 +28,10 @@ accounting.account.forms module :undoc-members: :show-inheritance: -accounting.account.query module -------------------------------- +accounting.account.queries module +--------------------------------- -.. automodule:: accounting.account.query +.. automodule:: accounting.account.queries :members: :undoc-members: :show-inheritance: diff --git a/docs/source/accounting.base_account.rst b/docs/source/accounting.base_account.rst index 3bbf2f5..3c18256 100644 --- a/docs/source/accounting.base_account.rst +++ b/docs/source/accounting.base_account.rst @@ -20,10 +20,10 @@ accounting.base\_account.converters module :undoc-members: :show-inheritance: -accounting.base\_account.query module -------------------------------------- +accounting.base\_account.queries module +--------------------------------------- -.. automodule:: accounting.base_account.query +.. automodule:: accounting.base_account.queries :members: :undoc-members: :show-inheritance: diff --git a/docs/source/accounting.currency.rst b/docs/source/accounting.currency.rst index 9bdda6b..88a8982 100644 --- a/docs/source/accounting.currency.rst +++ b/docs/source/accounting.currency.rst @@ -28,10 +28,10 @@ accounting.currency.forms module :undoc-members: :show-inheritance: -accounting.currency.query module --------------------------------- +accounting.currency.queries module +---------------------------------- -.. automodule:: accounting.currency.query +.. automodule:: accounting.currency.queries :members: :undoc-members: :show-inheritance: diff --git a/docs/source/accounting.report.reports.rst b/docs/source/accounting.report.reports.rst new file mode 100644 index 0000000..6217750 --- /dev/null +++ b/docs/source/accounting.report.reports.rst @@ -0,0 +1,77 @@ +accounting.report.reports package +================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + accounting.report.reports.utils + +Submodules +---------- + +accounting.report.reports.balance\_sheet module +----------------------------------------------- + +.. automodule:: accounting.report.reports.balance_sheet + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.income\_expenses module +------------------------------------------------- + +.. automodule:: accounting.report.reports.income_expenses + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.income\_statement module +-------------------------------------------------- + +.. automodule:: accounting.report.reports.income_statement + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.journal module +---------------------------------------- + +.. automodule:: accounting.report.reports.journal + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.ledger module +--------------------------------------- + +.. automodule:: accounting.report.reports.ledger + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.search module +--------------------------------------- + +.. automodule:: accounting.report.reports.search + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.trial\_balance module +----------------------------------------------- + +.. automodule:: accounting.report.reports.trial_balance + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.report.reports + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.report.reports.utils.rst b/docs/source/accounting.report.reports.utils.rst new file mode 100644 index 0000000..e60a552 --- /dev/null +++ b/docs/source/accounting.report.reports.utils.rst @@ -0,0 +1,77 @@ +accounting.report.reports.utils package +======================================= + +Submodules +---------- + +accounting.report.reports.utils.base\_page\_params module +--------------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.base_page_params + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.base\_report module +--------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.base_report + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.csv\_export module +-------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.csv_export + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.option\_link module +--------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.option_link + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.period\_choosers module +------------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.period_choosers + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.report\_chooser module +------------------------------------------------------ + +.. automodule:: accounting.report.reports.utils.report_chooser + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.report\_type module +--------------------------------------------------- + +.. automodule:: accounting.report.reports.utils.report_type + :members: + :undoc-members: + :show-inheritance: + +accounting.report.reports.utils.urls module +------------------------------------------- + +.. automodule:: accounting.report.reports.utils.urls + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.report.reports.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.report.rst b/docs/source/accounting.report.rst new file mode 100644 index 0000000..6543981 --- /dev/null +++ b/docs/source/accounting.report.rst @@ -0,0 +1,61 @@ +accounting.report package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + accounting.report.reports + +Submodules +---------- + +accounting.report.converters module +----------------------------------- + +.. automodule:: accounting.report.converters + :members: + :undoc-members: + :show-inheritance: + +accounting.report.income\_expense\_account module +------------------------------------------------- + +.. automodule:: accounting.report.income_expense_account + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period module +------------------------------- + +.. automodule:: accounting.report.period + :members: + :undoc-members: + :show-inheritance: + +accounting.report.template\_filters module +------------------------------------------ + +.. automodule:: accounting.report.template_filters + :members: + :undoc-members: + :show-inheritance: + +accounting.report.views module +------------------------------ + +.. automodule:: accounting.report.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.report + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.rst b/docs/source/accounting.rst index acc3f0c..46bf8c8 100644 --- a/docs/source/accounting.rst +++ b/docs/source/accounting.rst @@ -10,6 +10,7 @@ Subpackages accounting.account accounting.base_account accounting.currency + accounting.report accounting.transaction accounting.utils @@ -32,6 +33,22 @@ accounting.models module :undoc-members: :show-inheritance: +accounting.template\_filters module +----------------------------------- + +.. automodule:: accounting.template_filters + :members: + :undoc-members: + :show-inheritance: + +accounting.template\_globals module +----------------------------------- + +.. automodule:: accounting.template_globals + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/accounting.transaction.rst b/docs/source/accounting.transaction.rst index 6249218..c3a7502 100644 --- a/docs/source/accounting.transaction.rst +++ b/docs/source/accounting.transaction.rst @@ -12,14 +12,6 @@ accounting.transaction.converters module :undoc-members: :show-inheritance: -accounting.transaction.dispatcher module ----------------------------------------- - -.. automodule:: accounting.transaction.dispatcher - :members: - :undoc-members: - :show-inheritance: - accounting.transaction.forms module ----------------------------------- @@ -28,26 +20,26 @@ accounting.transaction.forms module :undoc-members: :show-inheritance: -accounting.transaction.query module ------------------------------------ +accounting.transaction.operators module +--------------------------------------- -.. automodule:: accounting.transaction.query +.. automodule:: accounting.transaction.operators :members: :undoc-members: :show-inheritance: -accounting.transaction.summary\_helper module +accounting.transaction.summary\_editor module --------------------------------------------- -.. automodule:: accounting.transaction.summary_helper +.. automodule:: accounting.transaction.summary_editor :members: :undoc-members: :show-inheritance: -accounting.transaction.template module --------------------------------------- +accounting.transaction.template\_filters module +----------------------------------------------- -.. automodule:: accounting.transaction.template +.. automodule:: accounting.transaction.template_filters :members: :undoc-members: :show-inheritance: diff --git a/docs/source/accounting.utils.rst b/docs/source/accounting.utils.rst index 296f61a..f95c83b 100644 --- a/docs/source/accounting.utils.rst +++ b/docs/source/accounting.utils.rst @@ -60,6 +60,14 @@ accounting.utils.strip\_text module :undoc-members: :show-inheritance: +accounting.utils.txn\_types module +---------------------------------- + +.. automodule:: accounting.utils.txn_types + :members: + :undoc-members: + :show-inheritance: + accounting.utils.user module ----------------------------