Skip to content

Commit 4e2ef71

Browse files
committed
GHA, Docs: Ensure some files always pass Sphinx nitpicks
1 parent ed0540b commit 4e2ef71

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

.github/workflows/doc.yml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,23 @@ jobs:
5757
- name: Get list of changed files
5858
id: changed_files
5959
uses: jitterbit/get-changed-files@v1
60-
- name: 'Build with nitpicks'
60+
- name: 'Build changed files with nitpicks'
6161
continue-on-error: true
6262
run: |
6363
# Mark files the pull request modified
6464
touch ${{ steps.changed_files.outputs.added_modified }}
65-
# Build docs with the '-n' (nitpicky) option, convert warnings
66-
make -C Doc/ PYTHON=../python SPHINXOPTS="-q --keep-going -n" html 2>&1 |
65+
# Build docs with the '-n' (nit-picky) option, convert warnings
66+
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n --keep-going" html 2>&1 |
6767
python Doc/tools/warnings-to-gh-actions.py
6868
69+
# Ensure some files always pass Sphinx nitpicks (missing references)
70+
- name: 'Build others with nitpicks'
71+
run: |
72+
# Mark files that must pass nit-picky
73+
touch Doc/whatsnew/3.12.rst
74+
# Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W)
75+
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1
76+
6977
# Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release
7078
doctest:
7179
name: 'Doctest'

0 commit comments

Comments
 (0)