[CI/Build] Add sphinx/rst linter for docs (#10366)

This commit is contained in:
Rafael Vasquez
2024-11-20 00:35:31 -05:00
committed by GitHub
parent b4be5a8adb
commit 709c9f1f25
4 changed files with 42 additions and 0 deletions

32
.github/workflows/sphinx-lint.yml vendored Normal file
View File

@@ -0,0 +1,32 @@
name: Lint documentation
on:
push:
branches:
- main
paths:
- "docs/**"
pull_request:
branches:
- main
paths:
- "docs/**"
jobs:
sphinx-lint:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.12"]
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements-lint.txt
- name: Linting docs
run: tools/sphinx-lint.sh