Merge pull request #66 from xpsi-group/Documentation-updates #59
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: Build docs | |
on: | |
push: | |
branches: | |
- main | |
release: | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
shell: bash -l {0} | |
strategy: | |
fail-fast: false | |
max-parallel: 5 | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Install Conda environment with Micromamba | |
uses: mamba-org/setup-micromamba@v1 | |
with: | |
environment-file: environment.yml | |
cache-env: true | |
cache-env-key: env-envkey-${{ github.sha }}-${{ github.run_attempt }} | |
environment-name: neost | |
- name: mamba installs | |
run: | | |
micromamba install flake8 pytest | |
- name: install gsl | |
run: | | |
sudo apt-get install -y libgsl-dev | |
- name : install docs dependencies | |
run: | | |
micromamba install sphinx decorator h5py | |
micromamba install -c conda-forge nbsphinx nbconvert pandoc | |
pip install sphinxcontrib-websupport sphinx_rtd_theme | |
- name: install neost package | |
run: | | |
pip install . | |
shell: bash -l {0} | |
- name : build docs | |
run: | | |
make html | |
working-directory: docs/ | |
- name: Deploy to GitHub Pages | |
if: success() | |
uses: crazy-max/ghaction-github-pages@v3 | |
with: | |
target_branch: gh-pages | |
build_dir: docs/build/html | |
jekyll: false | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |