diff --git a/README.md b/README.md index d27fc42..b6ef1db 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/build_install_framework/action.yml b/build_install_framework/action.yml index af7bf58..cfd0c5b 100644 --- a/build_install_framework/action.yml +++ b/build_install_framework/action.yml @@ -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" @@ -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