Skip to content

Detect doc build failure #10

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.

Sign up for GitHub

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

Merged
glesur merged 4 commits into from
Jun 25, 2026
Merged

Detect doc build failure #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f288fc1
fix malformed tables
glesur Jun 25, 2026
fc6be00
test doc build and detect failures
glesur Jun 25, 2026
89a96ae
fix documentation tables
glesur Jun 25, 2026
7bea417
Potential fix for pull request finding
glesur Jun 25, 2026
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
6 changes: 5 additions & 1 deletion .github/workflows/astra-ci-doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Build documentation
on:
workflow_dispatch:
pull_request:
branches:
- master # Run on PRs targeting master
push:
branches:
- master
Expand All @@ -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 -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
Expand All @@ -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
Expand Down
40 changes: 20 additions & 20 deletions doc/source/input_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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. |
Expand Down
Loading