Skip to content

Commit 29cdbee

Browse files
authoredMar 27, 2023
Merge branch 'main' into pythongh-81079-glob-case-sensitive-arg-2
2 parents e386a54 + 2cdc518 commit 29cdbee

File tree

117 files changed

+2225
-2044
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+2225
-2044
lines changed
 

‎.github/workflows/doc.yml

+24
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,30 @@ jobs:
5353
- name: 'Build HTML documentation'
5454
run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html
5555

56+
# Add pull request annotations for Sphinx nitpicks (missing references)
57+
- name: 'Get list of changed files'
58+
id: changed_files
59+
uses: Ana06/get-changed-files@v2.2.0
60+
with:
61+
filter: "Doc/**"
62+
- name: 'Build changed files in nit-picky mode'
63+
continue-on-error: true
64+
run: |
65+
# Mark files the pull request modified
66+
touch ${{ steps.changed_files.outputs.added_modified }}
67+
# Build docs with the '-n' (nit-picky) option; convert warnings to annotations
68+
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n --keep-going" html 2>&1 |
69+
python Doc/tools/warnings-to-gh-actions.py
70+
71+
# Ensure some files always pass Sphinx nit-picky mode (no missing references)
72+
- name: 'Build known-good files in nit-picky mode'
73+
run: |
74+
# Mark files that must pass nit-picky
75+
touch Doc/whatsnew/3.12.rst
76+
touch Doc/library/sqlite3.rst
77+
# Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W)
78+
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1
79+
5680
# Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release
5781
doctest:
5882
name: 'Doctest'

‎Doc/c-api/exceptions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Printing and clearing
8686
8787
An exception must be set when calling this function.
8888
89-
.. c:function: void PyErr_DisplayException(PyObject *exc)
89+
.. c:function:: void PyErr_DisplayException(PyObject *exc)
9090
9191
Print the standard traceback display of ``exc`` to ``sys.stderr``, including
9292
chained exceptions and notes.

0 commit comments

Comments
 (0)
Please sign in to comment.