From 7d483111bbc99a30f07e718bc1daec204507decf Mon Sep 17 00:00:00 2001 From: Connor French Date: Fri, 9 Aug 2024 10:49:06 -0400 Subject: [PATCH] add deploy action for docs --- .github/workflows/deploy.yml | 50 +++++++++++++++++++++++++++++++++ docs/spaceprime-for-r-users.qmd | 2 +- 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..7da4550 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -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 + + diff --git a/docs/spaceprime-for-r-users.qmd b/docs/spaceprime-for-r-users.qmd index 56017f0..39b428b 100644 --- a/docs/spaceprime-for-r-users.qmd +++ b/docs/spaceprime-for-r-users.qmd @@ -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. :::