54 lines
1.6 KiB
YAML
54 lines
1.6 KiB
YAML
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
name: "Build Documentation"
|
|
on:
|
|
pull_request:
|
|
push:
|
|
|
|
jobs:
|
|
build-html:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- uses: actions/setup-python@v2
|
|
with:
|
|
python-version: '3.8'
|
|
- name: Generate requirements.txt file
|
|
run: |
|
|
cd Documentation/
|
|
pip3 install pipenv
|
|
pipenv lock -r > requirements.txt
|
|
- uses: ammaraskar/sphinx-problem-matcher@master
|
|
- uses: ammaraskar/sphinx-action@master
|
|
with:
|
|
docs-folder: "Documentation/"
|
|
- uses: actions/upload-artifact@v2
|
|
with:
|
|
name: sphinx-docs
|
|
path: Documentation/_build/html/
|
|
linkcheck:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v1
|
|
- uses: actions/setup-python@v2
|
|
with:
|
|
python-version: '3.8'
|
|
- uses: ammaraskar/sphinx-problem-matcher@master
|
|
- name: Run linkcheck
|
|
run: |
|
|
cd Documentation/
|
|
pip3 install pipenv
|
|
pipenv install
|
|
# This step flakes frequently so still annotate errors but dont fail the build
|
|
pipenv run make linkcheck || true
|