Skip to content

Commit

Permalink
Merge pull request #2 from arcaneframework/dev/ah-userdoc-devdoc
Browse files Browse the repository at this point in the history
Add userdoc and devdoc building
  • Loading branch information
AlexlHer authored Dec 6, 2023
2 parents 53a2a1d + 7177c31 commit 8e25662
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ You have six composite actions to build and install the Arcane Framework.
| `compilo` | Compiler to build the Framework. You can choose `GCC` or `Clang`. If you want an other compiler, you can use `cmake_additionnal_args` input. | No (`GCC`) |
| `with_cuda` | Use CUDA to compile GPU part of the framework. Need `nvcc` compiler. | No (`false`) |
| `with_samples` | Build samples. Need an `install_dir`. | No (`false`) |
| `with_userdoc` | Build the user documentation. Available in `build_dir/share/userdoc`. | No (`false`) |
| `with_devdoc` | Build the dev documentation. Available in `build_dir/share/devdoc`. | No (`false`) |

### Example for the first composite action:
https://github.com/arcaneframework/gh_actions/blob/master/.github/workflows/reusable_test_framework.yml
Expand Down
23 changes: 22 additions & 1 deletion build_install_framework/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,16 @@ inputs:
type: boolean
required: false
default: false

with_userdoc:
description: 'Build the user documentation'
type: boolean
required: false
default: false
with_devdoc:
description: 'Build the developer documentation'
type: boolean
required: false
default: false

runs:
using: "composite"
Expand Down Expand Up @@ -154,6 +163,18 @@ runs:
run: |
cmake --install ${{ inputs.build_dir }}
- name: Build userdoc
if: "${{ inputs.with_userdoc == 'true' }}"
shell: bash
run: |
cmake --build ${{ inputs.build_dir }} --target userdoc
- name: Build devdoc
if: "${{ inputs.with_devdoc == 'true' }}"
shell: bash
run: |
cmake --build ${{ inputs.build_dir }} --target devdoc
- name: Configure samples
if: "${{ inputs.with_samples == 'true' && inputs.install_dir != '' }}"
shell: bash
Expand Down

0 comments on commit 8e25662

Please sign in to comment.