Link to documentation in README #35
Workflow file for this run
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: Documentation | |
on: | |
push: { branches: [ "master" ] } | |
pull_request: { branches: [ "master" ] } | |
concurrency: | |
group: doc-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
build-manual: | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v2 | |
with: { submodules: recursive } | |
- uses: conda-incubator/setup-miniconda@v2 | |
with: { miniforge-variant: "Mambaforge", miniforge-version: "latest", python-version: "3.9" } | |
- name: install dependencies | |
shell: bash -l {0} | |
run: | | |
mamba env update --quiet -n test -f environment.yml | |
mamba env update --quiet -n test -f doc/environment.yml | |
conda list | |
- name: fix permissions | |
shell: bash -l {0} | |
run: | | |
# Strangely, the linkchecker modules are installed writable and linkchecker then refuses to load them. | |
chmod -R a-w `python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"` | |
- name: build gmpxxll | |
shell: bash -l {0} | |
run: | | |
echo "::group::bootstrap" | |
./bootstrap | |
echo "::group::configure" | |
./configure --prefix=${CONDA_PREFIX} --without-benchmark --without-byexample | |
echo "::group::make" | |
make | |
- name: build documentation | |
shell: bash -l {0} | |
run: | | |
make html | |
- name: detect broken links | |
shell: bash -l {0} | |
run: | | |
python -m http.server 8880 --directory doc/manual/generated/html & | |
sleep 1 | |
linkchecker --check-extern http://localhost:8880/gmpxxll --ignore-url '^https://flatsurf.github.io/gmpxxll/.*$' | |
- uses: JamesIves/[email protected] | |
with: | |
branch: gh-pages | |
folder: doc/manual/generated/html/gmpxxll | |
target-folder: docs | |
if: ${{ github.event_name == 'push' }} |