Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 97b42f8

Browse filesBrowse files
authored
Merge pull request #23868 from oscargus/sphinxerrorwarnings
Show errors and warnings in doc CI after build.
2 parents d6bad5f + c35de8c commit 97b42f8
Copy full SHA for 97b42f8

File tree

Expand file treeCollapse file tree

3 files changed

+27
-9
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+27
-9
lines changed

‎.circleci/config.yml

Copy file name to clipboardExpand all lines: .circleci/config.yml
+21-1Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,32 @@ commands:
141141
[ "$CIRCLE_PR_NUMBER" = "" ]; then
142142
export RELEASE_TAG='-t release'
143143
fi
144-
make html O="-T $RELEASE_TAG -j4"
144+
make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"
145145
rm -r build/html/_sources
146146
working_directory: doc
147147
- save_cache:
148148
key: sphinx-env-v1-{{ .BuildNum }}-{{ .Environment.CIRCLE_JOB }}
149149
paths:
150150
- doc/build/doctrees
151151

152+
doc-show-errors-warnings:
153+
steps:
154+
- run:
155+
name: Extract possible build errors and warnings
156+
command: |
157+
(grep "WARNING\|ERROR" /tmp/sphinxerrorswarnings.log ||
158+
echo "No errors or warnings")
159+
160+
doc-show-deprecations:
161+
steps:
162+
- run:
163+
name: Extract possible deprecation warnings in examples and tutorials
164+
command: |
165+
(grep DeprecationWarning -r -l doc/build/html/gallery ||
166+
echo "No deprecation warnings in gallery")
167+
(grep DeprecationWarning -r -l doc/build/html/tutorials ||
168+
echo "No deprecation warnings in tutorials")
169+
152170
doc-bundle:
153171
steps:
154172
- run:
@@ -186,6 +204,8 @@ jobs:
186204
- doc-deps-install
187205

188206
- doc-build
207+
- doc-show-errors-warnings
208+
- doc-show-deprecations
189209

190210
- doc-bundle
191211

‎examples/images_contours_and_fields/pcolormesh_grids.py

Copy file name to clipboardExpand all lines: examples/images_contours_and_fields/pcolormesh_grids.py
+4-5Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,10 @@ def _annotate(ax, x, y, title):
5454
# -----------------------------
5555
#
5656
# Often, however, data is provided where *X* and *Y* match the shape of *Z*.
57-
# While this makes sense for other ``shading`` types, it is no longer permitted
58-
# when ``shading='flat'`` (and will raise a MatplotlibDeprecationWarning as of
59-
# Matplotlib v3.3). Historically, Matplotlib silently dropped the last row and
60-
# column of *Z* in this case, to match Matlab's behavior. If this behavior is
61-
# still desired, simply drop the last row and column manually:
57+
# While this makes sense for other ``shading`` types, it is not permitted
58+
# when ``shading='flat'``. Historically, Matplotlib silently dropped the last
59+
# row and column of *Z* in this case, to match Matlab's behavior. If this
60+
# behavior is still desired, simply drop the last row and column manually:
6261

6362
x = np.arange(ncols) # note *not* ncols + 1 as before
6463
y = np.arange(nrows)

‎examples/images_contours_and_fields/pcolormesh_levels.py

Copy file name to clipboardExpand all lines: examples/images_contours_and_fields/pcolormesh_levels.py
+2-3Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,8 @@
5252
# Often a user wants to pass *X* and *Y* with the same sizes as *Z* to
5353
# `.axes.Axes.pcolormesh`. This is also allowed if ``shading='auto'`` is
5454
# passed (default set by :rc:`pcolor.shading`). Pre Matplotlib 3.3,
55-
# ``shading='flat'`` would drop the last column and row of *Z*; while that
56-
# is still allowed for back compatibility purposes, a DeprecationWarning is
57-
# raised. If this is really what you want, then simply drop the last row and
55+
# ``shading='flat'`` would drop the last column and row of *Z*, but now gives
56+
# an error. If this is really what you want, then simply drop the last row and
5857
# column of Z manually:
5958

6059
x = np.arange(10) # len = 10

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.