From 308e4ac69dcbe7db6e30b155b0121dacf19baa3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Fri, 10 Mar 2023 08:36:08 +0800 Subject: [PATCH] Updated the Sphinx documentation. --- docs/source/accounting.report.period.rst | 69 +++++++++++++++++ docs/source/accounting.report.reports.rst | 8 -- .../accounting.report.reports.utils.rst | 77 ------------------- docs/source/accounting.report.rst | 18 +---- docs/source/accounting.report.utils.rst | 77 +++++++++++++++++++ 5 files changed, 148 insertions(+), 101 deletions(-) create mode 100644 docs/source/accounting.report.period.rst delete mode 100644 docs/source/accounting.report.reports.utils.rst create mode 100644 docs/source/accounting.report.utils.rst diff --git a/docs/source/accounting.report.period.rst b/docs/source/accounting.report.period.rst new file mode 100644 index 0000000..d58ef02 --- /dev/null +++ b/docs/source/accounting.report.period.rst @@ -0,0 +1,69 @@ +accounting.report.period package +================================ + +Submodules +---------- + +accounting.report.period.chooser module +--------------------------------------- + +.. automodule:: accounting.report.period.chooser + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.description module +------------------------------------------- + +.. automodule:: accounting.report.period.description + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.month\_end module +------------------------------------------ + +.. automodule:: accounting.report.period.month_end + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.parser module +-------------------------------------- + +.. automodule:: accounting.report.period.parser + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.period module +-------------------------------------- + +.. automodule:: accounting.report.period.period + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.shortcuts module +----------------------------------------- + +.. automodule:: accounting.report.period.shortcuts + :members: + :undoc-members: + :show-inheritance: + +accounting.report.period.specification module +--------------------------------------------- + +.. automodule:: accounting.report.period.specification + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.report.period + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.report.reports.rst b/docs/source/accounting.report.reports.rst index 6217750..a622a33 100644 --- a/docs/source/accounting.report.reports.rst +++ b/docs/source/accounting.report.reports.rst @@ -1,14 +1,6 @@ accounting.report.reports package ================================= -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - accounting.report.reports.utils - Submodules ---------- diff --git a/docs/source/accounting.report.reports.utils.rst b/docs/source/accounting.report.reports.utils.rst deleted file mode 100644 index e60a552..0000000 --- a/docs/source/accounting.report.reports.utils.rst +++ /dev/null @@ -1,77 +0,0 @@ -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 index 6543981..14ffaa4 100644 --- a/docs/source/accounting.report.rst +++ b/docs/source/accounting.report.rst @@ -7,7 +7,9 @@ Subpackages .. toctree:: :maxdepth: 4 + accounting.report.period accounting.report.reports + accounting.report.utils Submodules ---------- @@ -20,22 +22,6 @@ accounting.report.converters module :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 ------------------------------------------ diff --git a/docs/source/accounting.report.utils.rst b/docs/source/accounting.report.utils.rst new file mode 100644 index 0000000..6d0a06b --- /dev/null +++ b/docs/source/accounting.report.utils.rst @@ -0,0 +1,77 @@ +accounting.report.utils package +=============================== + +Submodules +---------- + +accounting.report.utils.base\_page\_params module +------------------------------------------------- + +.. automodule:: accounting.report.utils.base_page_params + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.base\_report module +------------------------------------------- + +.. automodule:: accounting.report.utils.base_report + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.csv\_export module +------------------------------------------ + +.. automodule:: accounting.report.utils.csv_export + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.ie\_account module +------------------------------------------ + +.. automodule:: accounting.report.utils.ie_account + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.option\_link module +------------------------------------------- + +.. automodule:: accounting.report.utils.option_link + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.report\_chooser module +---------------------------------------------- + +.. automodule:: accounting.report.utils.report_chooser + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.report\_type module +------------------------------------------- + +.. automodule:: accounting.report.utils.report_type + :members: + :undoc-members: + :show-inheritance: + +accounting.report.utils.urls module +----------------------------------- + +.. automodule:: accounting.report.utils.urls + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.report.utils + :members: + :undoc-members: + :show-inheritance: