Update docs instructions to include installation of sphinx-autobuild #518
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: Doc QA | |
on: | |
# Triggers the workflow on pull request events for the main branch | |
pull_request_target: | |
types: | |
- opened | |
permissions: | |
pull-requests: write | |
jobs: | |
pyspell: | |
runs-on: ubuntu-latest | |
steps: | |
# Spellcheck | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: igsekor/[email protected] | |
name: Spellcheck | |
doctor-rst: | |
name: Lint (DOCtor-RST) | |
runs-on: ubuntu-latest | |
steps: | |
- name: "Checkout" | |
uses: actions/checkout@v4 | |
- name: "Create cache dir" | |
run: mkdir .cache | |
- name: "Extract base branch name" | |
run: echo "branch=${GITHUB_BASE_REF:-${GITHUB_REF##*/}}" | |
id: extract_base_branch | |
- name: "Cache DOCtor-RST" | |
uses: actions/cache@v4 | |
with: | |
path: .cache | |
key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }} | |
- name: "Run DOCtor-RST" | |
uses: docker://oskarstark/doctor-rst:1.23.0 | |
with: | |
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache | |
documentation-preview: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: readthedocs/actions/preview@v1 | |
with: | |
project-slug: "datacube-core" |