Skip to content

Add typo checking for *.rst and *.md files #2158

Add typo checking for *.rst and *.md files

Add typo checking for *.rst and *.md files #2158

Workflow file for this run

# Adapted from agda/agda/.github/workflows/user-manual.yml by Andreas, 2021-09-11
name: Assorted
# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency.
concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true
on:
push:
branches:
- master
paths:
- 'doc/Makefile'
- 'doc/pyproject.toml'
- 'doc/requirements.in'
- 'doc/*.inc'
- 'doc/*.py'
- 'doc/*.rst'
- 'doc/**/*.json'
- '.github/workflows/users-guide.yml'
pull_request:
paths:
- 'doc/Makefile'
- 'doc/pyproject.toml'
- 'doc/requirements.in'
- 'doc/*.inc'
- 'doc/*.py'
- 'doc/*.rst'
- 'doc/**/*.json'
- '.github/workflows/users-guide.yml'
release:
types:
- created
defaults:
run:
shell: bash
jobs:
build:
name: Users guide
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.10']
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install pip-compile
run: |
pip install pip-tools
- name: Create requirements.txt from requirements.in
run: |
make users-guide-requirements
# Subsumed by make users-guide
# - name: Install dependencies
# run: |
# pip install -r doc/requirements.txt
- name: Build User's Guide in HTML
run: |
make SPHINX_HTML_OUTDIR=html users-guide
- uses: actions/upload-artifact@v4
with:
name: users-guide-html
path: html/
- name: Check security of requirements.txt
env:
SKJOLD_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
make -C doc check-requirements