Update install_on_linux.md #169
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
| # Workflow name | |
| name: "Documentation Build" | |
| # Event that must trigger the workflow | |
| on: | |
| push: # <- trigger when we call push | |
| branches: | |
| - main # <- but only on main branch | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| # Use bash instead of sh for conda activation | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| # Task to do when launching the workflow | |
| steps: | |
| # 1. First get the repository source | |
| - name: "Checkout" | |
| uses: actions/checkout@v2 | |
| # 2. Sphinx part : install tool and dependencies | |
| # See https://github.com/conda-incubator/setup-miniconda#caching-environments | |
| - name: Setup a conda-incubator with an empty conda env | |
| uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| python-version: 3.9.12 | |
| miniforge-variant: Mambaforge | |
| miniforge-version: latest | |
| use-mamba: true | |
| # For caching to work: | |
| use-only-tar-bz2: true | |
| # Environment to create and activate for next steps | |
| activate-environment: myria3d | |
| # Cache the conda environment | |
| # See https://github.com/conda-incubator/setup-miniconda#caching-environments | |
| - name: Get Date | |
| id: get-date | |
| run: echo "::set-output name=today::$(/bin/date -u '+%Y%m%d')" | |
| shell: bash | |
| - name: Cache conda environment | |
| uses: actions/cache@v2 | |
| with: | |
| path: ${{ env.CONDA }}/envs | |
| key: conda-${{ runner.os }}--${{ runner.arch }}--${{ steps.get-date.outputs.today }}-${{ hashFiles('environment.yml') }} | |
| env: | |
| # Increase this value to reset cache if env has not changed. | |
| CACHE_NUMBER: 0 | |
| id: cache | |
| - name: Update environment if there was no cached env. | |
| run: mamba env update -n myria3d -f environment.yml | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| - name: List installed packages | |
| run: mamba list | |
| - name: "Build Sphinx Doc" | |
| working-directory: ./docs/ | |
| run: make html | |
| # 3. Déploiement sur les Github Pages | |
| - name: "Deploy Github Pages" | |
| uses: JamesIves/[email protected] | |
| with: | |
| BRANCH: gh-pages # <- Branch where generated doc files will be commited | |
| FOLDER: docs/build/html/ # <- Dir where .nojekyll is created and from which to deploy github pages. |