Skip to content

modify docstring to Points object #487

modify docstring to Points object

modify docstring to Points object #487

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/[email protected]
with:
branch: gh-pages
folder: api/gplately/
target-folder: dev-doc/