Documentation for all index types #326
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: Docs | |
| on: [push, pull_request] | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.10'] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Dependencies | |
| run: | | |
| set -x | |
| set -e | |
| # $CONDA is an environment variable pointing to the root of the miniconda directory | |
| echo $CONDA/bin >> $GITHUB_PATH | |
| conda config --set always_yes yes --set changeps1 no | |
| conda config --add channels conda-forge | |
| conda update -q conda | |
| conda info -a | |
| conda create -n test-environment python=${{ matrix.python-version }} --file docs/requirements.txt | |
| conda init | |
| - name: Build Docs | |
| run: | | |
| # Copied from .bashrc. We can't just source .bashrc because it exits | |
| # when the shell isn't interactive. | |
| # >>> conda initialize >>> | |
| # !! Contents within this block are managed by 'conda init' !! | |
| __conda_setup="$('/usr/share/miniconda/bin/conda' 'shell.bash' 'hook' 2> /dev/null)" | |
| if [ $? -eq 0 ]; then | |
| eval "$__conda_setup" | |
| else | |
| if [ -f "/usr/share/miniconda/etc/profile.d/conda.sh" ]; then | |
| . "/usr/share/miniconda/etc/profile.d/conda.sh" | |
| else | |
| export PATH="/usr/share/miniconda/bin:$PATH" | |
| fi | |
| fi | |
| unset __conda_setup | |
| # <<< conda initialize <<< | |
| set -x | |
| set -e | |
| conda activate test-environment | |
| cd docs | |
| make html | |
| # Note, the gh-pages deployment requires setting up a SSH deploy key. | |
| # See | |
| # https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key- | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| folder: docs/_build/html | |
| ssh-key: ${{ secrets.DEPLOY_KEY }} | |
| clean-exclude: benchmarks/ |