From 7fc748763f6aaddf0692e82c5cb7c51c0824fa25 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Wed, 25 Mar 2026 10:23:56 -0400 Subject: [PATCH 1/2] adding in an rst linter --- .github/workflows/rst_lint.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/rst_lint.yml diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml new file mode 100644 index 000000000..8708a3450 --- /dev/null +++ b/.github/workflows/rst_lint.yml @@ -0,0 +1,32 @@ +name: reStructuredText Lint +on: + push: + branches: + - 'main' + pull_request: + +jobs: + run_lint: + runs-on: ubuntu-latest + steps: + - name: Code Checkout + uses: actions/checkout@v4 + - name: Make Sphinx Requirements + run: | + echo "sphinx" > requirements.txt + echo "sphinx_rtd_theme" >> requirements.txt + echo "sphinx_design" >> requirements.txt + echo "sphinx-sitemap" >> requirements.txt + echo "sphinxcontrib-mermaid" >> requirements.txt + echo "doc8" >> requirements.txt + - name: Prepare Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'pip' + - name: Install Python Requirements + run: | + pip install -r requirements.txt + pip install doc8 + - name: Lint RST files + run: doc8 source From 692639d4981b3f9d0ff36af01f138f3e428d2469 Mon Sep 17 00:00:00 2001 From: Lauren Chilutti Date: Wed, 25 Mar 2026 10:28:33 -0400 Subject: [PATCH 2/2] modiy lint workflow - it had a copy paste error --- .github/workflows/rst_lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rst_lint.yml b/.github/workflows/rst_lint.yml index 8708a3450..f1360680a 100644 --- a/.github/workflows/rst_lint.yml +++ b/.github/workflows/rst_lint.yml @@ -29,4 +29,4 @@ jobs: pip install -r requirements.txt pip install doc8 - name: Lint RST files - run: doc8 source + run: doc8 *