Skip to content

Commit

Permalink
Merge pull request #133 from MDAnalysis/fix-doc-deployment
Browse files Browse the repository at this point in the history
fix doc deployment
  • Loading branch information
lilyminium authored Oct 22, 2023
2 parents 21032fb + 16d86d0 commit aee81c2
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 22 deletions.
35 changes: 14 additions & 21 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ on:
push:
branches:
- master
pull_request:
branches:
- master

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

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

fetch-depth: 0
- name: setup_miniconda
uses: conda-incubator/setup-miniconda@v2
with:
python-version: 3.9
python-version: 3.11
environment-file: ci/environment.yaml
auto-update-conda: true
channel-priority: flexible
channels: conda-forge
add-pip-as-python-dependency: true
mamba-version: "*"

- name: install package deps
run: |
mamba install numpy scipy pytest pytest-cov codecov sphinx
pip install sphinx-sitemap sphinx-rtd-theme
- name: check install
run: |
which python
which pip
conda info
conda list
miniforge-variant: Mambaforge
use-mamba: true

- name: install package
run: |
pip install -v .
- name: build docs
run: |
python setup.py build_sphinx
cd doc && sphinx-build -b html source build
- name: deploy docs
uses: peaceiris/actions-gh-pages@v3
if: github.event_name != 'pull_request'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build/sphinx/html
publish_dir: ./doc/build
user_name: 'github-actions'
user_email: 'github-action@users.noreply.github.com'
2 changes: 1 addition & 1 deletion ci/environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ dependencies:
# documentation
- mdanalysis-sphinx-theme >=1.0.1
- pip:
- sphinx_sitemap
- sphinx-sitemap
2 changes: 2 additions & 0 deletions ci/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
numpy
scipy
mrcfile
mdanalysis-sphinx-theme >=1.0.1
sphinx-sitemap

0 comments on commit aee81c2

Please sign in to comment.