chore(docs): update api docs with sphinx-apidoc

HydroRoll-Team · Sep 8, 2024 · 4740b00 · 4740b00
1 parent 7b85695
commit 4740b00
Show file tree

Hide file tree

Showing 110 changed files with 5,127 additions and 29 deletions.
diff --git a/docs/source/api/GetPlayerCard.rst b/docs/source/api/GetPlayerCard.rst
@@ -0,0 +1,18 @@
+GetPlayerCard package
+=====================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   GetPlayerCard.version
+
+Module contents
+---------------
+
+.. automodule:: GetPlayerCard
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/GetPlayerCard.version.rst b/docs/source/api/GetPlayerCard.version.rst
@@ -0,0 +1,7 @@
+GetPlayerCard.version module
+============================
+
+.. automodule:: GetPlayerCard.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.cli.rst b/docs/source/api/HydroRoll.cli.rst
@@ -0,0 +1,7 @@
+HydroRoll.cli module
+====================
+
+.. automodule:: HydroRoll.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.config.rst b/docs/source/api/HydroRoll.config.rst
@@ -0,0 +1,7 @@
+HydroRoll.config module
+=======================
+
+.. automodule:: HydroRoll.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.exceptions.rst b/docs/source/api/HydroRoll.exceptions.rst
@@ -0,0 +1,7 @@
+HydroRoll.exceptions module
+===========================
+
+.. automodule:: HydroRoll.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.models.rst b/docs/source/api/HydroRoll.models.rst
@@ -0,0 +1,18 @@
+HydroRoll.models package
+========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.models.utils
+
+Module contents
+---------------
+
+.. automodule:: HydroRoll.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/hydro_roll.exceptions.rst → docs/source/api/HydroRoll.models.utils.rst b/docs/source/api/hydro_roll.exceptions.rst → docs/source/api/HydroRoll.models.utils.rst
@@ -1,7 +1,7 @@
-hydro\_roll.exceptions module
+HydroRoll.models.utils module
 =============================
 
-.. automodule:: hydro_roll.exceptions
+.. automodule:: HydroRoll.models.utils
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/hydro_roll.rst → docs/source/api/HydroRoll.rst b/docs/source/api/hydro_roll.rst → docs/source/api/HydroRoll.rst
@@ -1,30 +1,30 @@
-hydro\_roll package
-===================
+HydroRoll package
+=================
 
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
-   hydro_roll.models
+   HydroRoll.models
 
 Submodules
 ----------
 
 .. toctree::
    :maxdepth: 4
 
-   hydro_roll.cli
-   hydro_roll.config
-   hydro_roll.exceptions
-   hydro_roll.typing
-   hydro_roll.utils
+   HydroRoll.cli
+   HydroRoll.config
+   HydroRoll.exceptions
+   HydroRoll.typing
+   HydroRoll.utils
 
 Module contents
 ---------------
 
-.. automodule:: hydro_roll
+.. automodule:: HydroRoll
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/HydroRoll.typing.rst b/docs/source/api/HydroRoll.typing.rst
@@ -0,0 +1,7 @@
+HydroRoll.typing module
+=======================
+
+.. automodule:: HydroRoll.typing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/hydro_roll.cli.rst → docs/source/api/HydroRoll.utils.rst b/docs/source/api/hydro_roll.cli.rst → docs/source/api/HydroRoll.utils.rst
@@ -1,7 +1,7 @@
-hydro\_roll.cli module
+HydroRoll.utils module
 ======================
 
-.. automodule:: hydro_roll.cli
+.. automodule:: HydroRoll.utils
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/hydro_roll.utils.rst → docs/source/api/HydroRollCore.cli.rst b/docs/source/api/hydro_roll.utils.rst → docs/source/api/HydroRollCore.cli.rst
@@ -1,7 +1,7 @@
-hydro\_roll.utils module
+HydroRollCore.cli module
 ========================
 
-.. automodule:: hydro_roll.utils
+.. automodule:: HydroRollCore.cli
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.config.rst b/docs/source/api/HydroRollCore.config.rst
@@ -0,0 +1,7 @@
+HydroRollCore.config module
+===========================
+
+.. automodule:: HydroRollCore.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.const.rst b/docs/source/api/HydroRollCore.const.rst
@@ -0,0 +1,7 @@
+HydroRollCore.const module
+==========================
+
+.. automodule:: HydroRollCore.const
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/hydro_roll.config.rst → docs/source/api/HydroRollCore.core.rst b/docs/source/api/hydro_roll.config.rst → docs/source/api/HydroRollCore.core.rst
@@ -1,7 +1,7 @@
-hydro\_roll.config module
+HydroRollCore.core module
 =========================
 
-.. automodule:: hydro_roll.config
+.. automodule:: HydroRollCore.core
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dependencies.rst b/docs/source/api/HydroRollCore.dependencies.rst
@@ -0,0 +1,7 @@
+HydroRollCore.dependencies module
+=================================
+
+.. automodule:: HydroRollCore.dependencies
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dev.character.rst b/docs/source/api/HydroRollCore.dev.character.rst
@@ -0,0 +1,7 @@
+HydroRollCore.dev.character module
+==================================
+
+.. automodule:: HydroRollCore.dev.character
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dev.echo.rst b/docs/source/api/HydroRollCore.dev.echo.rst
@@ -0,0 +1,7 @@
+HydroRollCore.dev.echo module
+=============================
+
+.. automodule:: HydroRollCore.dev.echo
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dev.grps.rst b/docs/source/api/HydroRollCore.dev.grps.rst
@@ -0,0 +1,18 @@
+HydroRollCore.dev.grps package
+==============================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.dev.grps.v1
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.dev.grps
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dev.grps.v1.rst b/docs/source/api/HydroRollCore.dev.grps.v1.rst
@@ -0,0 +1,7 @@
+HydroRollCore.dev.grps.v1 module
+================================
+
+.. automodule:: HydroRollCore.dev.grps.v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.dev.rst b/docs/source/api/HydroRollCore.dev.rst
@@ -0,0 +1,27 @@
+HydroRollCore.dev package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.dev.grps
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.dev.character
+   HydroRollCore.dev.echo
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.dev
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.doc.rst b/docs/source/api/HydroRollCore.doc.rst
@@ -0,0 +1,10 @@
+HydroRollCore.doc package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.doc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.event.rst b/docs/source/api/HydroRollCore.event.rst
@@ -0,0 +1,7 @@
+HydroRollCore.event module
+==========================
+
+.. automodule:: HydroRollCore.event
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/hydro_roll.models.utils.rst → docs/source/api/HydroRollCore.exceptions.rst b/docs/source/api/hydro_roll.models.utils.rst → docs/source/api/HydroRollCore.exceptions.rst
@@ -1,7 +1,7 @@
-hydro\_roll.models.utils module
+HydroRollCore.exceptions module
 ===============================
 
-.. automodule:: hydro_roll.models.utils
+.. automodule:: HydroRollCore.exceptions
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.feat.rst b/docs/source/api/HydroRollCore.feat.rst
@@ -0,0 +1,10 @@
+HydroRollCore.feat package
+==========================
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.feat
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.log.rst b/docs/source/api/HydroRollCore.log.rst
@@ -0,0 +1,7 @@
+HydroRollCore.log module
+========================
+
+.. automodule:: HydroRollCore.log
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.perf.rst b/docs/source/api/HydroRollCore.perf.rst
@@ -0,0 +1,10 @@
+HydroRollCore.perf package
+==========================
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.perf
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.rst b/docs/source/api/HydroRollCore.rst
@@ -0,0 +1,39 @@
+HydroRollCore package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.dev
+   HydroRollCore.doc
+   HydroRollCore.feat
+   HydroRollCore.perf
+   HydroRollCore.rule
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.cli
+   HydroRollCore.config
+   HydroRollCore.const
+   HydroRollCore.core
+   HydroRollCore.dependencies
+   HydroRollCore.event
+   HydroRollCore.exceptions
+   HydroRollCore.log
+   HydroRollCore.typing
+   HydroRollCore.utils
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.rule.BaseRule.CharacterCard.rst b/docs/source/api/HydroRollCore.rule.BaseRule.CharacterCard.rst
@@ -0,0 +1,7 @@
+HydroRollCore.rule.BaseRule.CharacterCard module
+================================================
+
+.. automodule:: HydroRollCore.rule.BaseRule.CharacterCard
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.rule.BaseRule.CustomRule.rst b/docs/source/api/HydroRollCore.rule.BaseRule.CustomRule.rst
@@ -0,0 +1,7 @@
+HydroRollCore.rule.BaseRule.CustomRule module
+=============================================
+
+.. automodule:: HydroRollCore.rule.BaseRule.CustomRule
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.rule.BaseRule.Wiki.rst b/docs/source/api/HydroRollCore.rule.BaseRule.Wiki.rst
@@ -0,0 +1,7 @@
+HydroRollCore.rule.BaseRule.Wiki module
+=======================================
+
+.. automodule:: HydroRollCore.rule.BaseRule.Wiki
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRollCore.rule.BaseRule.rst b/docs/source/api/HydroRollCore.rule.BaseRule.rst
@@ -0,0 +1,20 @@
+HydroRollCore.rule.BaseRule package
+===================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRollCore.rule.BaseRule.CharacterCard
+   HydroRollCore.rule.BaseRule.CustomRule
+   HydroRollCore.rule.BaseRule.Wiki
+
+Module contents
+---------------
+
+.. automodule:: HydroRollCore.rule.BaseRule
+   :members:
+   :undoc-members:
+   :show-inheritance: