1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
name: Documentation
on:
push: { branches: [ "master" ] }
pull_request: { branches: [ "master" ] }
concurrency:
group: doc-${{ github.ref }}
cancel-in-progress: true
jobs:
build-manual:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with: { submodules: recursive }
- uses: conda-incubator/setup-miniconda@v2
with: { miniforge-variant: "Mambaforge", miniforge-version: "latest" }
- name: Install pplpy dependencies
shell: bash -l {0}
run: |
mamba env update --quiet -n test -f environment.yml
conda list
- name: Install pplpy
shell: bash -l {0}
run: |
pip install --verbose --no-index --no-build-isolation .
- name: Install test dependencies
run: |
mamba env update --quiet -n test -f environment.test.yml
conda list
- name: Build documentation
shell: bash -l {0}
run:
sphinx-build docs/source html/pplpy
- name: Detect broken links
shell: bash -l {0}
run: |
python -m http.server 8880 --directory html &
sleep 1
# We ignore _modules since sphinx puts all modules in the module
# overview but does not generate pages for .pyx modules.
linkchecker --check-extern --ignore-url=_modules/ http://localhost:8880
- uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: html/pplpy/
TARGET_FOLDER: docs/
if: ${{ github.event_name == 'push' }}
|
