From be8579cc913ab7243b79310dfee00b32da40f53b Mon Sep 17 00:00:00 2001 From: Eduardo Enriquez Date: Sun, 25 Feb 2024 12:32:52 +0100 Subject: [PATCH 1/3] Add gha workflow for docs (#20) --- .github/workflows/docs.yml | 41 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..1e50dbe --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,41 @@ +name: Docs + +on: + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + push: + branches: + - main + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + docs: + runs-on: ubuntu-22.04 + name: docs + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + cache: 'pip' + + - run: python -m pip install -e . [docs] + + - name: Build docs + run: | + cd docs + sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling From 544c1b7411ecd9f048595dbf7c9e70696b07a304 Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Sun, 25 Feb 2024 12:37:11 +0100 Subject: [PATCH 2/3] Fixed workflow typo. --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1e50dbe..038cd7e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: python-version: '3.11' cache: 'pip' - - run: python -m pip install -e . [docs] + - run: python -m pip install -e .[docs] - name: Build docs run: | From 94cc999d0c71ca31cffe3e2a5608d5e40af76bec Mon Sep 17 00:00:00 2001 From: Carlton Gibson Date: Sun, 25 Feb 2024 12:41:01 +0100 Subject: [PATCH 3/3] Use JSON builder for docs workflow. --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 038cd7e..cd783f1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -38,4 +38,5 @@ jobs: - name: Build docs run: | cd docs - sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling + make json +# sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling