From d09255432d4a8af5a2a0e386ed16f0444ea75d33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= Date: Thu, 8 Dec 2022 00:52:49 +0800 Subject: [PATCH] Applied Sphinx autodoc, and added the automatically-generated module documents to the documentation. --- docs/source/accounting.migrations.rst | 21 ++++++ docs/source/accounting.rst | 94 +++++++++++++++++++++++++ docs/source/accounting.templatetags.rst | 21 ++++++ docs/source/conf.py | 12 +++- docs/source/mia_core.migrations.rst | 10 +++ docs/source/mia_core.rst | 70 ++++++++++++++++++ docs/source/mia_core.templatetags.rst | 21 ++++++ docs/source/modules.rst | 8 +++ 8 files changed, 255 insertions(+), 2 deletions(-) create mode 100644 docs/source/accounting.migrations.rst create mode 100644 docs/source/accounting.rst create mode 100644 docs/source/accounting.templatetags.rst create mode 100644 docs/source/mia_core.migrations.rst create mode 100644 docs/source/mia_core.rst create mode 100644 docs/source/mia_core.templatetags.rst create mode 100644 docs/source/modules.rst diff --git a/docs/source/accounting.migrations.rst b/docs/source/accounting.migrations.rst new file mode 100644 index 0000000..09e29c9 --- /dev/null +++ b/docs/source/accounting.migrations.rst @@ -0,0 +1,21 @@ +accounting.migrations package +============================= + +Submodules +---------- + +accounting.migrations.0001\_initial module +------------------------------------------ + +.. automodule:: accounting.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.rst b/docs/source/accounting.rst new file mode 100644 index 0000000..0bef50e --- /dev/null +++ b/docs/source/accounting.rst @@ -0,0 +1,94 @@ +accounting package +================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + accounting.migrations + accounting.templatetags + +Submodules +---------- + +accounting.apps module +---------------------- + +.. automodule:: accounting.apps + :members: + :undoc-members: + :show-inheritance: + +accounting.converters module +---------------------------- + +.. automodule:: accounting.converters + :members: + :undoc-members: + :show-inheritance: + +accounting.forms module +----------------------- + +.. automodule:: accounting.forms + :members: + :undoc-members: + :show-inheritance: + +accounting.models module +------------------------ + +.. automodule:: accounting.models + :members: + :undoc-members: + :show-inheritance: + +accounting.tests module +----------------------- + +.. automodule:: accounting.tests + :members: + :undoc-members: + :show-inheritance: + +accounting.urls module +---------------------- + +.. automodule:: accounting.urls + :members: + :undoc-members: + :show-inheritance: + +accounting.utils module +----------------------- + +.. automodule:: accounting.utils + :members: + :undoc-members: + :show-inheritance: + +accounting.validators module +---------------------------- + +.. automodule:: accounting.validators + :members: + :undoc-members: + :show-inheritance: + +accounting.views module +----------------------- + +.. automodule:: accounting.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/accounting.templatetags.rst b/docs/source/accounting.templatetags.rst new file mode 100644 index 0000000..112db3f --- /dev/null +++ b/docs/source/accounting.templatetags.rst @@ -0,0 +1,21 @@ +accounting.templatetags package +=============================== + +Submodules +---------- + +accounting.templatetags.accounting module +----------------------------------------- + +.. automodule:: accounting.templatetags.accounting + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: accounting.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index 9a723d9..d09fedf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,6 +2,14 @@ # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import os +import sys +import django + +sys.path.insert(0, os.path.abspath('../../src/')) +sys.path.append(os.path.abspath('../../tests/test_site/')) +os.environ["DJANGO_SETTINGS_MODULE"] = "test_site.settings" +django.setup() # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information @@ -14,7 +22,7 @@ release = '0.1.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = ["sphinx.ext.autodoc"] templates_path = ['_templates'] exclude_patterns = [] @@ -24,5 +32,5 @@ exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] diff --git a/docs/source/mia_core.migrations.rst b/docs/source/mia_core.migrations.rst new file mode 100644 index 0000000..4159edd --- /dev/null +++ b/docs/source/mia_core.migrations.rst @@ -0,0 +1,10 @@ +mia\_core.migrations package +============================ + +Module contents +--------------- + +.. automodule:: mia_core.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/mia_core.rst b/docs/source/mia_core.rst new file mode 100644 index 0000000..b214f70 --- /dev/null +++ b/docs/source/mia_core.rst @@ -0,0 +1,70 @@ +mia\_core package +================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + mia_core.migrations + mia_core.templatetags + +Submodules +---------- + +mia\_core.apps module +--------------------- + +.. automodule:: mia_core.apps + :members: + :undoc-members: + :show-inheritance: + +mia\_core.models module +----------------------- + +.. automodule:: mia_core.models + :members: + :undoc-members: + :show-inheritance: + +mia\_core.period module +----------------------- + +.. automodule:: mia_core.period + :members: + :undoc-members: + :show-inheritance: + +mia\_core.tests module +---------------------- + +.. automodule:: mia_core.tests + :members: + :undoc-members: + :show-inheritance: + +mia\_core.utils module +---------------------- + +.. automodule:: mia_core.utils + :members: + :undoc-members: + :show-inheritance: + +mia\_core.views module +---------------------- + +.. automodule:: mia_core.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: mia_core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/mia_core.templatetags.rst b/docs/source/mia_core.templatetags.rst new file mode 100644 index 0000000..3c30a0e --- /dev/null +++ b/docs/source/mia_core.templatetags.rst @@ -0,0 +1,21 @@ +mia\_core.templatetags package +============================== + +Submodules +---------- + +mia\_core.templatetags.mia\_core module +--------------------------------------- + +.. automodule:: mia_core.templatetags.mia_core + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: mia_core.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..01cc94d --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,8 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + accounting + mia_core