Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix doc deployment #133

Merged
merged 1 commit into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:O good catch here!

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
Loading