From 6206f79cfcfdab94e5cf13726bb71bb2a2e8bbff Mon Sep 17 00:00:00 2001 From: comrumino Date: Thu, 12 Oct 2023 18:54:39 -0500 Subject: [PATCH] Added workflow for #543/sphinx-build to validate links and nit-picky --- .github/workflows/sphinx-build.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/sphinx-build.yml diff --git a/.github/workflows/sphinx-build.yml b/.github/workflows/sphinx-build.yml new file mode 100644 index 00000000..1dce0764 --- /dev/null +++ b/.github/workflows/sphinx-build.yml @@ -0,0 +1,23 @@ +name: "Docs Check and Build" +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + docs-linkcheck-nitpicky: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3 + uses: actions/setup-python@v4 + with: + python-version: 3.12 + - name: Install Dependencies + run: | + pip install docs/requirements.txt + - name: Build linkcheck with nit-picky mode + working-directory: docs + run: | + sphinx-build -W --keep-going -b linkcheck -n -d _build/doctrees . _build/linkcheck