Refactor some gplately.tools
into new gplately.spatial
module
#494
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: Build docs and deploy to GitHub Pages | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
branches: | |
- master | |
jobs: | |
build-and-deploy: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
shell: bash -l {0} | |
if: github.event.pull_request.draft == false | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: mamba-org/setup-micromamba@v1 | |
with: | |
micromamba-version: "1.5.8-0" | |
environment-file: conda/doc-env.yml | |
init-shell: >- | |
bash | |
cache-environment: true | |
post-cleanup: "all" | |
- name: Install current gplately | |
run: | | |
pip install . --no-binary :all: --no-cache-dir --no-dependencies | |
- name: test pygmt | |
run: python -c "import pygmt" | |
shell: bash -el {0} | |
- name: test jupyter-nbconvert | |
run: jupyter-nbconvert --version | |
shell: bash -el {0} | |
- name: test pdoc | |
run: pdoc --version | |
shell: bash -el {0} | |
- name: Generate documentation with pdoc3 | |
run: pdoc --config latex_math=True --template-dir .pdoc_template --html -o api --force gplately | |
shell: bash -el {0} | |
- name: Convert jupyter notebooks to html | |
run: jupyter-nbconvert --to=html --output-dir=api/gplately/ Notebooks/*.ipynb | |
shell: bash -el {0} | |
- name: Deploy to gh-pages | |
uses: JamesIves/github-pages-deploy-action@v4.2.2 | |
with: | |
branch: gh-pages | |
folder: api/gplately/ | |
target-folder: dev-doc/ |