aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/api
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-03-10 07:08:44 +0800
committer简律纯 <i@jyunko.cn>2024-03-10 07:08:44 +0800
commit2a43b4540ffd94667b4cf1aaac04654497f7f692 (patch)
tree7de081518cca6d29e1dcc641ff7613564ac5c673 /docs/source/api
parentd8c68acdcf29f62589197f15fdb394df7ff7a049 (diff)
downloadHydroRoll-2a43b4540ffd94667b4cf1aaac04654497f7f692.tar.gz
HydroRoll-2a43b4540ffd94667b4cf1aaac04654497f7f692.zip
chore(docs): complete page
Diffstat (limited to 'docs/source/api')
-rw-r--r--docs/source/api/hydro_roll.cli.rst7
-rw-r--r--docs/source/api/hydro_roll.config.rst7
-rw-r--r--docs/source/api/hydro_roll.exceptions.rst7
-rw-r--r--docs/source/api/hydro_roll.hydro_roll.rst7
-rw-r--r--docs/source/api/hydro_roll.models.rst18
-rw-r--r--docs/source/api/hydro_roll.models.utils.rst7
-rw-r--r--docs/source/api/hydro_roll.rst31
-rw-r--r--docs/source/api/hydro_roll.typing.rst7
-rw-r--r--docs/source/api/hydro_roll.utils.rst7
-rw-r--r--docs/source/api/index.rst7
10 files changed, 105 insertions, 0 deletions
diff --git a/docs/source/api/hydro_roll.cli.rst b/docs/source/api/hydro_roll.cli.rst
new file mode 100644
index 0000000..93c24fe
--- /dev/null
+++ b/docs/source/api/hydro_roll.cli.rst
@@ -0,0 +1,7 @@
+hydro\_roll.cli module
+======================
+
+.. automodule:: hydro_roll.cli
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.config.rst b/docs/source/api/hydro_roll.config.rst
new file mode 100644
index 0000000..026e76c
--- /dev/null
+++ b/docs/source/api/hydro_roll.config.rst
@@ -0,0 +1,7 @@
+hydro\_roll.config module
+=========================
+
+.. automodule:: hydro_roll.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.exceptions.rst b/docs/source/api/hydro_roll.exceptions.rst
new file mode 100644
index 0000000..bccb1d3
--- /dev/null
+++ b/docs/source/api/hydro_roll.exceptions.rst
@@ -0,0 +1,7 @@
+hydro\_roll.exceptions module
+=============================
+
+.. automodule:: hydro_roll.exceptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.hydro_roll.rst b/docs/source/api/hydro_roll.hydro_roll.rst
new file mode 100644
index 0000000..f4a11bb
--- /dev/null
+++ b/docs/source/api/hydro_roll.hydro_roll.rst
@@ -0,0 +1,7 @@
+hydro\_roll.hydro\_roll module
+==============================
+
+.. automodule:: hydro_roll.hydro_roll
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.models.rst b/docs/source/api/hydro_roll.models.rst
new file mode 100644
index 0000000..50723e0
--- /dev/null
+++ b/docs/source/api/hydro_roll.models.rst
@@ -0,0 +1,18 @@
+hydro\_roll.models package
+==========================
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.models.utils
+
+Module contents
+---------------
+
+.. automodule:: hydro_roll.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.models.utils.rst b/docs/source/api/hydro_roll.models.utils.rst
new file mode 100644
index 0000000..aacd2e9
--- /dev/null
+++ b/docs/source/api/hydro_roll.models.utils.rst
@@ -0,0 +1,7 @@
+hydro\_roll.models.utils module
+===============================
+
+.. automodule:: hydro_roll.models.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.rst b/docs/source/api/hydro_roll.rst
new file mode 100644
index 0000000..136c69d
--- /dev/null
+++ b/docs/source/api/hydro_roll.rst
@@ -0,0 +1,31 @@
+hydro\_roll package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.models
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.cli
+ hydro_roll.config
+ hydro_roll.exceptions
+ hydro_roll.hydro_roll
+ hydro_roll.typing
+ hydro_roll.utils
+
+Module contents
+---------------
+
+.. automodule:: hydro_roll
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.typing.rst b/docs/source/api/hydro_roll.typing.rst
new file mode 100644
index 0000000..6638d5c
--- /dev/null
+++ b/docs/source/api/hydro_roll.typing.rst
@@ -0,0 +1,7 @@
+hydro\_roll.typing module
+=========================
+
+.. automodule:: hydro_roll.typing
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.utils.rst b/docs/source/api/hydro_roll.utils.rst
new file mode 100644
index 0000000..3083df1
--- /dev/null
+++ b/docs/source/api/hydro_roll.utils.rst
@@ -0,0 +1,7 @@
+hydro\_roll.utils module
+========================
+
+.. automodule:: hydro_roll.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
new file mode 100644
index 0000000..0216263
--- /dev/null
+++ b/docs/source/api/index.rst
@@ -0,0 +1,7 @@
+hydro_roll
+==========
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll