Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat submodule #107

Merged
merged 24 commits into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
0a84571
chore(submodules): update submodules with new repos and paths, adjust…
HsiangNianian Sep 8, 2024
08228d5
chore(submodules): remove outdated submodules and adjust workflow for…
HsiangNianian Sep 8, 2024
042c4fe
(chore(submodules): remove outdated submodules and adjust workflow fo…
HsiangNianian Sep 8, 2024
3a5bbb5
chore(submodules): add new submodule echo and update workflow for api…
HsiangNianian Sep 8, 2024
69cc657
chore(submodules): add new submodules TRPGNivis, HydroRollCore, GetPl…
HsiangNianian Sep 8, 2024
ed30adc
chore(submodules): add new submodules DiceParser, infini and update w…
HsiangNianian Sep 8, 2024
20713d4
chore(submodules): move submodules, update api docs build and remove …
HsiangNianian Sep 8, 2024
53cbbfa
chore(submodules): move submodules, update api docs build and remove …
HsiangNianian Sep 8, 2024
380562e
chore(submodules): update submodules with new repos and paths, adjust…
HsiangNianian Sep 8, 2024
e2a136e
chore(submodules): move submodules, update api docs build and remove …
HsiangNianian Sep 8, 2024
1d8958f
chore(submodules): update submodules with new repos and paths, adjust…
HsiangNianian Sep 8, 2024
3844d79
chore(docs): update api docs with sphinx-apidoc
HsiangNianian Sep 8, 2024
ef79984
chore(submodules): update api docs build workflow with combined commands
HsiangNianian Sep 8, 2024
8c9c28d
Merge branch 'feat-submodule' of https://github.com/HydroRoll-Team/Hy…
HsiangNianian Sep 8, 2024
b8c2be4
chore(docs): update api docs with sphinx-apidoc
HsiangNianian Sep 8, 2024
412ba45
chore(submodules): move submodules, update api docs build and remove …
HsiangNianian Sep 8, 2024
2f81278
Merge branch 'feat-submodule' of https://github.com/HydroRoll-Team/Hy…
HsiangNianian Sep 8, 2024
7b85695
chore(submodules): update submodules with new repos and paths, adjust…
HsiangNianian Sep 8, 2024
4740b00
chore(docs): update api docs with sphinx-apidoc
HsiangNianian Sep 8, 2024
12373e0
chore(submodules): remove submodules and update api docs build workflow
HsiangNianian Sep 8, 2024
dde37cd
Merge branch 'feat-submodule' of https://github.com/HydroRoll-Team/Hy…
HsiangNianian Sep 8, 2024
fb803a6
chore(submodules): move submodules, update api docs build and remove …
HsiangNianian Sep 8, 2024
5b985ca
chore(submodules): move submodules again, adjust api docs build workflow
HsiangNianian Sep 8, 2024
ef8d2dc
chore(docs): update api docs with sphinx-apidoc
HsiangNianian Sep 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .git-blame-ignore-revs

This file was deleted.

1 change: 0 additions & 1 deletion .gitattributes

This file was deleted.

24 changes: 20 additions & 4 deletions .github/workflows/build-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
25 changes: 19 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions DiceParser
Submodule DiceParser added at 9fe3f0
1 change: 1 addition & 0 deletions GetPlayerCard
Submodule GetPlayerCard added at 7d50ad
1 change: 1 addition & 0 deletions HydroRollCore
Submodule HydroRollCore added at 9e18d7
1 change: 1 addition & 0 deletions TRPGNivis
Submodule TRPGNivis added at 97245a
1 change: 1 addition & 0 deletions conventional_role_play
Submodule conventional_role_play added at e5681a
18 changes: 18 additions & 0 deletions docs/source/api/GetPlayerCard.get_pc.rst
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/source/api/GetPlayerCard.get_pc.version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
GetPlayerCard.get\_pc.version module
====================================

.. automodule:: GetPlayerCard.get_pc.version
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/source/api/GetPlayerCard.version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
GetPlayerCard.version module
============================

.. automodule:: GetPlayerCard.version
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.cli module
====================

.. automodule:: HydroRoll.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.config module
=======================

.. automodule:: HydroRoll.config
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.exceptions module
===========================

.. automodule:: HydroRoll.exceptions
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.cli module
================================

.. automodule:: HydroRoll.hydro_roll.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.config module
===================================

.. automodule:: HydroRoll.hydro_roll.config
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.exceptions module
=======================================

.. automodule:: HydroRoll.hydro_roll.exceptions
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.models.rst
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.models.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.models.utils module
=========================================

.. automodule:: HydroRoll.hydro_roll.models.utils
:members:
:undoc-members:
:show-inheritance:
30 changes: 30 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.rst
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.typing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.typing module
===================================

.. automodule:: HydroRoll.hydro_roll.typing
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.hydro_roll.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.hydro\_roll.utils module
==================================

.. automodule:: HydroRoll.hydro_roll.utils
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/source/api/HydroRoll.models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
HydroRoll.models package
========================

Submodules
----------

.. toctree::
:maxdepth: 4

HydroRoll.models.utils

Module contents
---------------

.. automodule:: HydroRoll.models
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -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:
31 changes: 31 additions & 0 deletions docs/source/api/HydroRoll.rst
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRoll.typing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRoll.typing module
=======================

.. automodule:: HydroRoll.typing
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
hydro\_roll.cli module
HydroRoll.utils module
======================

.. automodule:: hydro_roll.cli
.. automodule:: HydroRoll.utils
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
hydro\_roll.utils module
HydroRollCore.cli module
========================

.. automodule:: hydro_roll.utils
.. automodule:: HydroRollCore.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRollCore.config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRollCore.config module
===========================

.. automodule:: HydroRollCore.config
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRollCore.const.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRollCore.const module
==========================

.. automodule:: HydroRollCore.const
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
hydro\_roll.typing module
HydroRollCore.core module
=========================

.. automodule:: hydro_roll.typing
.. automodule:: HydroRollCore.core
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/api/HydroRollCore.dependencies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HydroRollCore.dependencies module
=================================

.. automodule:: HydroRollCore.dependencies
:members:
:undoc-members:
:show-inheritance:
Loading