Docstrings: docs API rendering #207
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: docs test | |
# Run this workflow when a review is requested on a PR that targets the main | |
# branch, or the PR is closed | |
on: | |
pull_request: | |
types: [review_requested, closed] | |
pull_request_review: | |
types: [submitted, dismissed] | |
# Prevent multiple PRs from building/deploying the docs at the same time | |
concurrency: | |
group: ${{ github.workflow }} | |
# test that the docs build | |
# (but don't deploy to gh-pages) | |
jobs: | |
build_docs: | |
runs-on: ubuntu-20.04 | |
strategy: | |
max-parallel: 4 | |
matrix: | |
python-version: ["3.8"] | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
# cache the Python environment, including installed dependencies | |
# (speeds up tests more than caching pip cache) | |
- name: Cache/Restore the Python env | |
uses: actions/cache@v3 | |
env: | |
cache-name: cache-python${{ matrix.python-version }}-env | |
with: | |
path: ${{ env.pythonLocation }} | |
key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }} | |
- name: Install doc dependencies | |
run: | | |
pip install .[docs] | |
- name: Install Pandoc dependency | |
run: | | |
sudo apt-get install pandoc | |
- name: Cache/Restore the .mpol folder cache | |
uses: actions/cache@v3 | |
env: | |
cache-name: cache-mpol-dls | |
with: | |
# files are stored in .mpol | |
path: ~/.mpol | |
# the "key" is the hash of the download script | |
key: ${{ hashFiles('docs/download_external_files.py') }} | |
- name: Build the docs | |
run: | | |
make -C docs clean | |
make -C docs html |