From f288fc130a9eb5988cca703f51540d8029f912d2 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Thu, 25 Jun 2026 09:28:41 +0200 Subject: [PATCH 1/4] fix malformed tables --- doc/source/input_file.rst | 42 +++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/source/input_file.rst b/doc/source/input_file.rst index 3ee0b96..e61d69e 100644 --- a/doc/source/input_file.rst +++ b/doc/source/input_file.rst @@ -81,7 +81,7 @@ Depending on the choice of the right-hand side, the following entries may be req | viscosity | float, (int) | | 1st parameter: kinematic viscosity | | | | | 2nd parameter (optional): order of the viscosity term *n* in :math:`=\nu \Delta^n v (default 1)` | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| omega | float | (optional) rotation rate along the x3 (=z) axis | +| omega | float | (optional) rotation rate along the x3 (=z) axis | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ | shear_type | string | (optional) type of large-scale shear. Value allowed: ``linear`` | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ @@ -114,25 +114,25 @@ Depending on the choice of the right-hand side, the following entries may be req ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| Entry name | Parameter type | Comment | -+=================+====================+===========================================================================================================+ -| viscosity | float, (int) | | 1st parameter: kinematic viscosity | -| | | | 2nd parameter (optional): order of the viscosity term *n* in :math:`=\nu \Delta^n v (default 1)` | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| eta_rho | float, (int) | | 1st parameter: mass diffusion | -| | | | 2nd parameter (optional): order of the diffusion term *n* in :math:`=\eta_\rho \Delta^n \rho (default 1)` | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| rho_floor | float | (optional) density floor (default 1e-6) | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| omega | float | (optional) rotation rate along the x3 (=z) axis | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| cs | float | (optional) isothermal sound speed (default 1) | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| shear_type | string | (optional) type of large-scale shear. Value allowed: ``linear`` | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| shear_rate | float | (optional) shear rate when `shear_type` is `linear` | -+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| Entry name | Parameter type | Comment | ++=================+====================+============================================================================================================+ +| viscosity | float, (int) | | 1st parameter: kinematic viscosity | +| | | | 2nd parameter (optional): order of the viscosity term *n* in :math:`=\nu \Delta^n v` (default 1) | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| eta_rho | float, (int) | | 1st parameter: mass diffusion | +| | | | 2nd parameter (optional): order of the diffusion term *n* in :math:`=\eta_\rho \Delta^n \rho` (default 1)| ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| rho_floor | float | (optional) density floor (default 1e-6) | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| omega | float | (optional) rotation rate along the x3 (=z) axis | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| cs | float | (optional) isothermal sound speed (default 1) | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| shear_type | string | (optional) type of large-scale shear. Value allowed: ``linear`` | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ +| shear_rate | float | (optional) shear rate when `shear_type` is `linear` | ++-----------------+--------------------+------------------------------------------------------------------------------------------------------------+ ``InitFlow`` section @@ -211,7 +211,7 @@ The definition of the entries in the Python section is as follows: | | | | - spectrum_vi.vj: shell-integrated power spectrum of the correlation :math:`v_i v_j`: | | | | | :math:`\int_{k-\Delta k/2}^{k+\Delta k/2} \langle \hat{v}_i(k) \hat{v}_j^*(k) \rangle dk` | +----------------+-------------------------+--------------------------------------------------------------------------------------------------+ -| timevar_dir | string | | directory for timevar file outputs. Default to "./timevar" | +| timevar_dir | string | | directory for timevar file outputs. Default to "./timevar" | | | | | The directory is automatically created if it does not exist. | +----------------+-------------------------+--------------------------------------------------------------------------------------------------+ | timevar_step | float | | Time interval between timevar outputs, in code units. | From fc6be00db5bab36fb8b3552ab626880a1c102aa1 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Thu, 25 Jun 2026 09:29:28 +0200 Subject: [PATCH 2/4] test doc build and detect failures --- .github/workflows/astra-ci-doc.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/astra-ci-doc.yml b/.github/workflows/astra-ci-doc.yml index f332f01..2a47672 100644 --- a/.github/workflows/astra-ci-doc.yml +++ b/.github/workflows/astra-ci-doc.yml @@ -1,6 +1,9 @@ name: Build documentation on: workflow_dispatch: + pull_request: + branches: + - master # Run on PRs targeting master push: branches: - master @@ -18,7 +21,7 @@ jobs: - name: install python dependencies run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation - run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source _build + run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source _build -W - name: Setup Pages uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 - name: Upload artifact @@ -27,6 +30,7 @@ jobs: path: '_build' deploy: needs: build + if: github.event_name == 'push' && github.ref == 'refs/heads/master' # Deploy only for master permissions: pages: write id-token: write From 89a96aefb274abbe6921f5fb70b3c7238b605188 Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Thu, 25 Jun 2026 09:33:08 +0200 Subject: [PATCH 3/4] fix documentation tables --- doc/source/input_file.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/input_file.rst b/doc/source/input_file.rst index e61d69e..2566147 100644 --- a/doc/source/input_file.rst +++ b/doc/source/input_file.rst @@ -81,7 +81,7 @@ Depending on the choice of the right-hand side, the following entries may be req | viscosity | float, (int) | | 1st parameter: kinematic viscosity | | | | | 2nd parameter (optional): order of the viscosity term *n* in :math:`=\nu \Delta^n v (default 1)` | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ -| omega | float | (optional) rotation rate along the x3 (=z) axis | +| omega | float | (optional) rotation rate along the x3 (=z) axis | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ | shear_type | string | (optional) type of large-scale shear. Value allowed: ``linear`` | +-----------------+--------------------+-----------------------------------------------------------------------------------------------------------+ From 7bea41765826b289c86fbcc8dcb789211e56fcab Mon Sep 17 00:00:00 2001 From: Geoffroy Lesur Date: Thu, 25 Jun 2026 10:21:24 +0200 Subject: [PATCH 4/4] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .github/workflows/astra-ci-doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/astra-ci-doc.yml b/.github/workflows/astra-ci-doc.yml index 2a47672..9456dfa 100644 --- a/.github/workflows/astra-ci-doc.yml +++ b/.github/workflows/astra-ci-doc.yml @@ -21,7 +21,7 @@ jobs: - name: install python dependencies run: python -m pip install --exists-action=w --no-cache-dir -r doc/python_requirements.txt - name: compile documentation - run: python -m sphinx -T -b html -d _build/doctrees -D language=en doc/source _build -W + run: python -m sphinx -T -W -b html -d _build/doctrees -D language=en doc/source _build - name: Setup Pages uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 - name: Upload artifact