Feat submodule (#107)

* chore(submodules): update submodules with new repos and paths, adjust workflow for api build * chore(submodules): remove outdated submodules and adjust workflow for api build * (chore(submodules): remove outdated submodules and adjust workflow for api build) * chore(submodules): add new submodule echo and update workflow for api build * chore(submodules): add new submodules TRPGNivis, HydroRollCore, GetPlayerCard, conventional_role_play, DiceParser and update workflow for api build * chore(submodules): add new submodules DiceParser, infini and update workflow for api build * chore(submodules): move submodules, update api docs build and remove old ones * chore(submodules): move submodules, update api docs build and remove old ones * chore(submodules): update submodules with new repos and paths, adjust workflow for api build * chore(submodules): move submodules, update api docs build and remove old ones * chore(submodules): update submodules with new repos and paths, adjust workflow for api build * chore(docs): update api docs with sphinx-apidoc * chore(submodules): update api docs build workflow with combined commands * chore(docs): update api docs with sphinx-apidoc * chore(submodules): move submodules, update api docs build and remove old ones again * chore(submodules): update submodules with new repos and paths, adjust workflow for api build * chore(docs): update api docs with sphinx-apidoc * chore(submodules): remove submodules and update api docs build workflow * chore(submodules): move submodules, update api docs build and remove old ones again * chore(submodules): move submodules again, adjust api docs build workflow * chore(docs): update api docs with sphinx-apidoc --------- Co-authored-by: HsiangNianian <[email protected]>
HydroRoll-Team · Sep 8, 2024 · 0131dda · 0131dda
1 parent 9cd70c8
commit 0131dda
Show file tree

Hide file tree

Showing 113 changed files with 1,087 additions and 42 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/build-api.yml b/.github/workflows/build-api.yml
@@ -37,13 +37,29 @@ jobs:
           - name: Remove API Doc
             run: rm -rf docs/source/api
 
-          - name: Build API Doc
+          - name: Clone Submodule
             run: |
-              pdm run sphinx-apidoc -o docs/source/api hydro_roll -f -e --tocfile index
-            shell: bash
+              git submodule update --init --recursive
+
+          - name: Moving Submodule
+            run: |
+              mkdir -p modules
+              mv DiceParser/src/oneroll modules/OneRoll
+              mv GetPlayerCard/get_pc modules/GetPlayerCard
+              mv HydroRollCore/hrc modules/HydroRollCore
+              mv TRPGNivis/nivis_python modules/TRPGNivisSDK
+
+          - name: Build API Doc For HydroRoll
+            run: |
+              cp -r hydro_roll modules/HydroRoll
+              pdm run sphinx-apidoc -o docs/source/api modules -f -e --tocfile index
+
+          - name: Remove Temp Folder
+            run: |
+              rm -rf modules
 
           - name: Commit 
             uses: stefanzweifel/git-auto-commit-action@v5
             with:
-              branch: main
+              branch: ${{ github.event.branch }}
               commit_message: "chore(docs): update api docs with sphinx-apidoc"
diff --git a/.gitmodules b/.gitmodules
@@ -1,8 +1,21 @@
-[submodule "hydro_roll_core"]
-	path = hydro_roll_core
-	url = https://github.com/HydroRoll-Team/HydroRollCore
-	branch = main
+[submodule "echo"]
+	path = echo
+	url = https://github.com/HydroRoll-Team/echo
 [submodule "TRPGNivis"]
-	path = TRPGNivisSDK
+	path = TRPGNivis
 	url = https://github.com/HydroRoll-Team/TRPGNivis
-	branch = main
+[submodule "HydroRollCore"]
+	path = HydroRollCore
+	url = https://github.com/HydroRoll-Team/HydroRollCore
+[submodule "GetPlayerCard"]
+	path = GetPlayerCard
+	url = https://github.com/HydroRoll-Team/GetPlayerCard
+[submodule "conventional_role_play"]
+	path = conventional_role_play
+	url = https://github.com/HydroRoll-Team/conventional_role_play
+[submodule "DiceParser"]
+	path = DiceParser
+	url = https://github.com/HydroRoll-Team/DiceParser
+[submodule "infini"]
+	path = infini
+	url = https://github.com/HydroRoll-Team/infini
diff --git a/DiceParser b/DiceParser
diff --git a/GetPlayerCard b/GetPlayerCard
diff --git a/HydroRollCore b/HydroRollCore
diff --git a/TRPGNivis b/TRPGNivis
diff --git a/conventional_role_play b/conventional_role_play
diff --git a/docs/source/api/GetPlayerCard.get_pc.rst b/docs/source/api/GetPlayerCard.get_pc.rst
@@ -0,0 +1,18 @@
+GetPlayerCard.get\_pc package
+=============================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   GetPlayerCard.get_pc.version
+
+Module contents
+---------------
+
+.. automodule:: GetPlayerCard.get_pc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/GetPlayerCard.get_pc.version.rst b/docs/source/api/GetPlayerCard.get_pc.version.rst
@@ -0,0 +1,7 @@
+GetPlayerCard.get\_pc.version module
+====================================
+
+.. automodule:: GetPlayerCard.get_pc.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/hydro_roll.rst → docs/source/api/GetPlayerCard.rst b/docs/source/api/hydro_roll.rst → docs/source/api/GetPlayerCard.rst
@@ -1,30 +1,26 @@
-hydro\_roll package
-===================
+GetPlayerCard package
+=====================
 
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
-   hydro_roll.models
+   GetPlayerCard.get_pc
 
 Submodules
 ----------
 
 .. toctree::
    :maxdepth: 4
 
-   hydro_roll.cli
-   hydro_roll.config
-   hydro_roll.exceptions
-   hydro_roll.typing
-   hydro_roll.utils
+   GetPlayerCard.version
 
 Module contents
 ---------------
 
-.. automodule:: hydro_roll
+.. 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.hydro_roll.cli.rst b/docs/source/api/HydroRoll.hydro_roll.cli.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.cli module
+================================
+
+.. automodule:: HydroRoll.hydro_roll.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.config.rst b/docs/source/api/HydroRoll.hydro_roll.config.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.config module
+===================================
+
+.. automodule:: HydroRoll.hydro_roll.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.exceptions.rst b/docs/source/api/HydroRoll.hydro_roll.exceptions.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.exceptions module
+=======================================
+
+.. automodule:: HydroRoll.hydro_roll.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.models.rst b/docs/source/api/HydroRoll.hydro_roll.models.rst
@@ -0,0 +1,18 @@
+HydroRoll.hydro\_roll.models package
+====================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.hydro_roll.models.utils
+
+Module contents
+---------------
+
+.. automodule:: HydroRoll.hydro_roll.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.models.utils.rst b/docs/source/api/HydroRoll.hydro_roll.models.utils.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.models.utils module
+=========================================
+
+.. automodule:: HydroRoll.hydro_roll.models.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.rst b/docs/source/api/HydroRoll.hydro_roll.rst
@@ -0,0 +1,30 @@
+HydroRoll.hydro\_roll package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.hydro_roll.models
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.hydro_roll.cli
+   HydroRoll.hydro_roll.config
+   HydroRoll.hydro_roll.exceptions
+   HydroRoll.hydro_roll.typing
+   HydroRoll.hydro_roll.utils
+
+Module contents
+---------------
+
+.. automodule:: HydroRoll.hydro_roll
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.typing.rst b/docs/source/api/HydroRoll.hydro_roll.typing.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.typing module
+===================================
+
+.. automodule:: HydroRoll.hydro_roll.typing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/HydroRoll.hydro_roll.utils.rst b/docs/source/api/HydroRoll.hydro_roll.utils.rst
@@ -0,0 +1,7 @@
+HydroRoll.hydro\_roll.utils module
+==================================
+
+.. automodule:: HydroRoll.hydro_roll.utils
+   :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/HydroRoll.rst b/docs/source/api/HydroRoll.rst
@@ -0,0 +1,31 @@
+HydroRoll package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.hydro_roll
+   HydroRoll.models
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   HydroRoll.cli
+   HydroRoll.config
+   HydroRoll.exceptions
+   HydroRoll.typing
+   HydroRoll.utils
+
+Module contents
+---------------
+
+.. 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.typing.rst → docs/source/api/HydroRollCore.core.rst b/docs/source/api/hydro_roll.typing.rst → docs/source/api/HydroRollCore.core.rst
@@ -1,7 +1,7 @@
-hydro\_roll.typing module
+HydroRollCore.core module
 =========================
 
-.. automodule:: hydro_roll.typing
+.. 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: