From dac62128e9c357303f869dc60fe3dcfe12025cb7 Mon Sep 17 00:00:00 2001 From: Malik Date: Sat, 6 Sep 2025 13:04:44 -0600 Subject: [PATCH 1/3] better control automatic gen of docs --- .github/workflows/build_docs.yml | 1 - .github/workflows/deploy_docs.yml | 1 - docs/source/bird.calibration.rst | 29 +++++++++++++++ docs/source/bird.meshing.rst | 37 +++++++++++++++++++ docs/source/bird.postprocess.rst | 53 +++++++++++++++++++++++++++ docs/source/bird.preprocess.rst | 10 +++++ docs/source/bird.rst | 15 ++++++++ docs/source/bird.utilities.rst | 61 +++++++++++++++++++++++++++++++ docs/source/index.rst | 1 + docs/source/modules.rst | 7 ++++ 10 files changed, 213 insertions(+), 2 deletions(-) create mode 100644 docs/source/bird.calibration.rst create mode 100644 docs/source/bird.meshing.rst create mode 100644 docs/source/bird.postprocess.rst create mode 100644 docs/source/bird.preprocess.rst create mode 100644 docs/source/bird.rst create mode 100644 docs/source/bird.utilities.rst create mode 100644 docs/source/modules.rst diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 41ad3c0d..7dc84c78 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -29,7 +29,6 @@ jobs: - name: Build documentation run: | - sphinx-apidoc -o docs/source bird cd docs make html diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index ad471357..f5424f58 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -30,7 +30,6 @@ jobs: - name: Build documentation run: | - sphinx-apidoc -o docs/source bird cd docs make html diff --git a/docs/source/bird.calibration.rst b/docs/source/bird.calibration.rst new file mode 100644 index 00000000..ebaff478 --- /dev/null +++ b/docs/source/bird.calibration.rst @@ -0,0 +1,29 @@ +bird.calibration package +======================== + +Submodules +---------- + +bird.calibration.param\_nn module +--------------------------------- + +.. automodule:: bird.calibration.param_nn + :members: + :undoc-members: + :show-inheritance: + +bird.calibration.scaling module +------------------------------- + +.. automodule:: bird.calibration.scaling + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bird.calibration + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bird.meshing.rst b/docs/source/bird.meshing.rst new file mode 100644 index 00000000..14a3c37e --- /dev/null +++ b/docs/source/bird.meshing.rst @@ -0,0 +1,37 @@ +bird.meshing package +==================== + +Submodules +---------- + +bird.meshing.block\_cyl\_mesh module +------------------------------------ + +.. automodule:: bird.meshing.block_cyl_mesh + :members: + :undoc-members: + :show-inheritance: + +bird.meshing.block\_rect\_mesh module +------------------------------------- + +.. automodule:: bird.meshing.block_rect_mesh + :members: + :undoc-members: + :show-inheritance: + +bird.meshing.stirred\_tank\_mesh module +--------------------------------------- + +.. automodule:: bird.meshing.stirred_tank_mesh + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bird.meshing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bird.postprocess.rst b/docs/source/bird.postprocess.rst new file mode 100644 index 00000000..b3e12d75 --- /dev/null +++ b/docs/source/bird.postprocess.rst @@ -0,0 +1,53 @@ +bird.postprocess package +======================== + +Submodules +---------- + +bird.postprocess.conditional\_mean module +----------------------------------------- + +.. automodule:: bird.postprocess.conditional_mean + :members: + :undoc-members: + :show-inheritance: + +bird.postprocess.early\_pred module +----------------------------------- + +.. automodule:: bird.postprocess.early_pred + :members: + :undoc-members: + :show-inheritance: + +bird.postprocess.kla\_utils module +---------------------------------- + +.. automodule:: bird.postprocess.kla_utils + :members: + :undoc-members: + :show-inheritance: + +bird.postprocess.post\_quantities module +---------------------------------------- + +.. automodule:: bird.postprocess.post_quantities + :members: + :undoc-members: + :show-inheritance: + +bird.postprocess.stats module +----------------------------- + +.. automodule:: bird.postprocess.stats + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bird.postprocess + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bird.preprocess.rst b/docs/source/bird.preprocess.rst new file mode 100644 index 00000000..117fec78 --- /dev/null +++ b/docs/source/bird.preprocess.rst @@ -0,0 +1,10 @@ +bird.preprocess package +======================= + +Module contents +--------------- + +.. automodule:: bird.preprocess + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bird.rst b/docs/source/bird.rst new file mode 100644 index 00000000..e8fb4a96 --- /dev/null +++ b/docs/source/bird.rst @@ -0,0 +1,15 @@ +BiRD API +============ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 1 + + bird.calibration + bird.meshing + bird.postprocess + bird.preprocess + bird.utilities + diff --git a/docs/source/bird.utilities.rst b/docs/source/bird.utilities.rst new file mode 100644 index 00000000..b33a5730 --- /dev/null +++ b/docs/source/bird.utilities.rst @@ -0,0 +1,61 @@ +bird.utilities package +====================== + +Submodules +---------- + +bird.utilities.folderManagement module +-------------------------------------- + +.. automodule:: bird.utilities.folderManagement + :members: + :undoc-members: + :show-inheritance: + +bird.utilities.label\_plot module +--------------------------------- + +.. automodule:: bird.utilities.label_plot + :members: + :undoc-members: + :show-inheritance: + +bird.utilities.mathtools module +------------------------------- + +.. automodule:: bird.utilities.mathtools + :members: + :undoc-members: + :show-inheritance: + +bird.utilities.ofio module +-------------------------- + +.. automodule:: bird.utilities.ofio + :members: + :undoc-members: + :show-inheritance: + +bird.utilities.parser module +---------------------------- + +.. automodule:: bird.utilities.parser + :members: + :undoc-members: + :show-inheritance: + +bird.utilities.stl\_plotting module +----------------------------------- + +.. automodule:: bird.utilities.stl_plotting + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bird.utilities + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst index 747210fd..a3643926 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -29,6 +29,7 @@ We provide a solver ``birdmultiphaseEulerFoam`` that contains custom models adde uq python_interface tutorials + bird contribute references troubleshoot diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..cc9335e3 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +bird +==== + +.. toctree:: + :maxdepth: 4 + + bird From a24a9ed53bee492e575821fd447d5b1e55a3987c Mon Sep 17 00:00:00 2001 From: Malik Date: Sat, 6 Sep 2025 13:06:22 -0600 Subject: [PATCH 2/3] force deploy --- .github/workflows/deploy_docs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index f5424f58..cb26c326 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -6,6 +6,11 @@ on: paths: - 'docs/**' - '.github/workflows/deploy_docs.yml' + pull_request: + branches: [ main ] + paths: + - 'docs/**' + - '.github/workflows/deploy_docs.yml' jobs: From 34e53ddc87c22db33ce026fb4995384d770294a3 Mon Sep 17 00:00:00 2001 From: Malik Date: Sat, 6 Sep 2025 13:12:22 -0600 Subject: [PATCH 3/3] pip install bird and then build api doc --- .github/workflows/build_docs.yml | 1 + .github/workflows/deploy_docs.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 7dc84c78..228de3e3 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -25,6 +25,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip + pip install -e . pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints - name: Build documentation diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index cb26c326..795210d7 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -31,6 +31,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip + pip install -e . pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints - name: Build documentation