Matthias Andreas Benkard | 12a5735 | 2021-12-28 18:02:04 +0100 | [diff] [blame^] | 1 | name: "Documentation" |
| 2 | |
| 3 | on: |
| 4 | pull_request: |
| 5 | push: |
| 6 | branches: |
| 7 | - '3.x' |
| 8 | |
| 9 | jobs: |
| 10 | build: |
| 11 | name: "Build" |
| 12 | |
| 13 | runs-on: ubuntu-latest |
| 14 | |
| 15 | steps: |
| 16 | - name: "Checkout code" |
| 17 | uses: actions/checkout@v2 |
| 18 | |
| 19 | - name: "Set up Python 3.7" |
| 20 | uses: actions/setup-python@v1 |
| 21 | with: |
| 22 | python-version: '3.7' # Semantic version range syntax or exact version of a Python version |
| 23 | |
| 24 | - name: "Display Python version" |
| 25 | run: python -c "import sys; print(sys.version)" |
| 26 | |
| 27 | - name: "Install Sphinx dependencies" |
| 28 | run: sudo apt-get install python-dev build-essential |
| 29 | |
| 30 | - name: "Cache pip" |
| 31 | uses: actions/cache@v2 |
| 32 | with: |
| 33 | path: ~/.cache/pip |
| 34 | key: ${{ runner.os }}-pip-${{ hashFiles('_build/.requirements.txt') }} |
| 35 | restore-keys: | |
| 36 | ${{ runner.os }}-pip- |
| 37 | |
| 38 | - name: "Install Sphinx + requirements via pip" |
| 39 | working-directory: "doc" |
| 40 | run: pip install -r _build/.requirements.txt |
| 41 | |
| 42 | - name: "Build documentation" |
| 43 | working-directory: "doc" |
| 44 | run: make -C _build SPHINXOPTS="-nqW -j auto" html |
| 45 | |
| 46 | doctor-rst: |
| 47 | name: "DOCtor-RST" |
| 48 | |
| 49 | runs-on: ubuntu-latest |
| 50 | |
| 51 | steps: |
| 52 | - name: "Checkout code" |
| 53 | uses: actions/checkout@v2 |
| 54 | |
| 55 | - name: "Run DOCtor-RST" |
| 56 | uses: docker://oskarstark/doctor-rst |
| 57 | with: |
| 58 | args: --short |
| 59 | env: |
| 60 | DOCS_DIR: 'doc/' |