improve doc on dl1ab #1295
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "Pull Request Docs Check" | |
| on: | |
| - push | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: '0' | |
| - name: Setup env | |
| uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| miniforge-variant: Mambaforge | |
| miniforge-version: latest | |
| activate-environment: lstmcpipe | |
| use-mamba: true | |
| - name: Update environment | |
| run: | | |
| mamba env update -n lstmcpipe -f environment.yml | |
| mamba install -n lstmcpipe -c conda-forge make pandoc | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| - name: Build docs | |
| run: | | |
| git config --global --add safe.directory '*' | |
| cd docs | |
| make html | |
| cd .. | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: DocumentationHTML | |
| path: docs/_build/html/ | |
| - name: Deploy to github pages | |
| # only run on push to master | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: JamesIves/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: docs/_build/html | |
| CLEAN: true | |
| SINGLE_COMMIT: true |