Commitc35de8c

committed

Show errors and warnings as well as deprecation warnings in doc CI after build.

1 parent06660ef commitc35de8cCopy full SHA for c35de8c

File tree

+27

-9

lines changed

+27

-9

lines changed

Lines changed: 21 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -141,14 +141,32 @@ commands:`
`141`	`141`	`[ "$CIRCLE_PR_NUMBER" = "" ]; then`
`142`	`142`	`export RELEASE_TAG='-t release'`
`143`	`143`	`fi`
`144`		`- make html O="-T $RELEASE_TAG -j4"`
	`144`	`+ make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"`
`145`	`145`	`rm -r build/html/_sources`
`146`	`146`	`working_directory:doc`
`147`	`147`	`-save_cache:`
`148`	`148`	`key:sphinx-env-v1-{{ .BuildNum }}-{{ .Environment.CIRCLE_JOB }}`
`149`	`149`	`paths:`
`150`	`150`	`-doc/build/doctrees`
`151`	`151`
	`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`	`+`
`152`	`170`	`doc-bundle:`
`153`	`171`	`steps:`
`154`	`172`	`-run:`
`@@ -186,6 +204,8 @@ jobs:`
`186`	`204`	`-doc-deps-install`
`187`	`205`
`188`	`206`	`-doc-build`
	`207`	`+ -doc-show-errors-warnings`
	`208`	`+ -doc-show-deprecations`
`189`	`209`
`190`	`210`	`-doc-bundle`
`191`	`211`

Lines changed: 4 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -54,11 +54,10 @@ def _annotate(ax, x, y, title):`
`54`	`54`	`# -----------------------------`
`55`	`55`	`#`
`56`	`56`	`# 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:`
`62`	`61`
`63`	`62`	`x=np.arange(ncols)# note not ncols + 1 as before`
`64`	`63`	`y=np.arange(nrows)`

Lines changed: 2 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,8 @@`
`52`	`52`	`# Often a user wants to pass X and Y with the same sizes as Z to`
`53`	`53`	# `.axes.Axes.pcolormesh`. This is also allowed if ``shading='auto'`` is
`54`	`54`	# 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`
`58`	`57`	`# column of Z manually:`
`59`	`58`
`60`	`59`	`x=np.arange(10)# len = 10`

Comments

(0)