remove bug message #21
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: developer_docs | |
# build the documentation whenever there are new commits on main | |
on: | |
push: | |
branches: | |
- main | |
# security: restrict permissions for CI jobs. | |
permissions: | |
contents: read | |
jobs: | |
# Build the documentation and upload the static HTML files as an artifact. | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.13' | |
- uses: conda-incubator/setup-miniconda@v3 | |
with: | |
auto-update-conda: true | |
python-version: ${{ matrix.python-version }} | |
mamba-version: "*" | |
channels: conda-forge,bioconda,defaults | |
- name: Add conda to system path | |
run: | | |
# $CONDA is an environment variable pointing to the root of the miniconda directory | |
echo $CONDA/bin >> $GITHUB_PATH | |
- name: Install conda dependencies | |
run: conda env update --file environment.yml --name base | |
- name: Build and install SACCHARIS | |
run: | | |
conda install conda-build | |
conda build . | |
conda install --use-local saccharis | |
- name: Install and run pdoc | |
run: | | |
conda install pdoc | |
pdoc -o docs src/saccharis --logo "https://github.com/saccharis/SACCHARIS_2/blob/main/logo_caps_light-dark.png?raw=true" | |
- uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/ | |
# Deploy the artifact to GitHub pages. | |
# This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
deploy: | |
needs: build | |
runs-on: ubuntu-latest | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- id: deployment | |
uses: actions/deploy-pages@v4 |