Skip to content

Commit

Permalink
install propkatraj for doc building (#71)
Browse files Browse the repository at this point in the history
* install propkatraj for doc building

- fix #66
- updated docs CI (updated version, make clear that we use conda-forge channel)

* run docs CI on PR

- always run doc build
- only deploy on push to main

* removed unused dev branch from main CI
  • Loading branch information
orbeckst authored May 8, 2024
1 parent b57a2b1 commit febb3a8
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
24 changes: 19 additions & 5 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ on:
push:
branches:
- main
pull_request:
branches:
- main

concurrency:
group: "${{ github.ref }}-${{ github.head_ref }}"
Expand All @@ -18,30 +21,41 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: setup_miniconda
uses: conda-incubator/setup-miniconda@v2
uses: conda-incubator/setup-miniconda@v3
with:
python-version: 3.11
environment-file: docs/requirements.yaml
auto-update-conda: true
channel-priority: flexible
channels: conda-forge
add-pip-as-python-dependency: true
architecture: x64

miniforge-variant: Mambaforge
use-mamba: true
channels: conda-forge

activate-environment: propkatrajdocs
auto-update-conda: true
auto-activate-base: false
show-channel-urls: true

- name: install dependencies
run: |
pip install pandas MDAnalysis propka==3.1
- name: install propkatraj
run: |
pip install .
- name: build docs
run: |
cd docs && sphinx-build -T -E --keep-going -b html -D language=en sphinx html
- name: deploy docs
if: github.event_name != 'pull_request'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/gh-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ on:
push:
branches:
- main
- dev
pull_request:
branches:
- main
- dev
schedule:
- cron: "0 0 * * 0"

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: propkatrajdocs
channels:
- default
- conda-forge
dependencies:
- python
- pip
Expand Down

0 comments on commit febb3a8

Please sign in to comment.