Skip to content

Commit

Permalink
add deploy action for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-french committed Aug 9, 2024
1 parent 6bb0756 commit 7d48311
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
50 changes: 50 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
on:
push:
branches:
- main


jobs:
tests:
name: "deploy-docs"
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.config.py }}
- name: Install GDAL
run: |
python -m pip install --upgrade pip
pip install --no-cache-dir Cython
pip install --find-links=https://girder.github.io/large_image_wheels --no-cache GDAL
- name: Test GDAL installation
run: |
python -c "from osgeo import gdal"
gdalinfo --version
- name: Install dependencies
run: |
pip install pytest
pip install --user -r requirements.txt
pip install -r requirements_tests.txt
pip install .
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
- name: build docs
run: |
make docs
- name: save docs
uses: actions/upload-artifact@v3
with:
name: docs-html
path: docs/_site
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _site
publish_branch: gh-pages


2 changes: 1 addition & 1 deletion docs/spaceprime-for-r-users.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ In Python, you can also import specific modules or functions from a package, rat
from spaceprime import demography
```

!::: {.callout-tip}
::: {.callout-tip}
## Modules
In Python, a module is a file that contains code you can use to perform specific tasks. This code can include functions, variables, and classes. Python packages typically contain multiple modules, each of which performs a specific set of tasks. Unlike in R, Python allows you to import specific modules or functions from a package, rather than having to load the entire package.
:::
Expand Down

0 comments on commit 7d48311

Please sign in to comment.