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 8c709f6

Browse filesBrowse files
committed
DOC: Document --keep-going and sphinx>=1.8.1 dependency
1 parent 9ee3cb7 commit 8c709f6
Copy full SHA for 8c709f6

File tree

Expand file treeCollapse file tree

2 files changed

+5
-4
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+5
-4
lines changed

‎doc/devel/documenting_mpl.rst

Copy file name to clipboardExpand all lines: doc/devel/documenting_mpl.rst
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,9 @@ Other useful invocations include
8181
# Build pdf docs.
8282
make latexpdf
8383
84-
The ``SPHINXOPTS`` variable is set to ``-W`` by default to turn warnings into
85-
errors. To unset it, use
84+
The ``SPHINXOPTS`` variable is set to ``-W --keep-going`` by default to build
85+
the complete docs but exit with exit status 1 if there are warnings. To unset
86+
it, use
8687

8788
.. code-block:: sh
8889
@@ -98,7 +99,7 @@ Multiple options can be combined using e.g. ``make O='-j4 -Dplot_gallery=0'
9899
html``.
99100

100101
On Windows, options needs to be set as environment variables, e.g. ``set O=-W
101-
-j4 & make html``.
102+
--keep-going -j4 & make html``.
102103

103104
.. _writing-rest-pages:
104105

‎requirements/doc/doc-requirements.txt

Copy file name to clipboardExpand all lines: requirements/doc/doc-requirements.txt
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Install the documentation requirements with:
88
# pip install -r requirements/doc/doc-requirements.txt
99
#
10-
sphinx>=1.3,!=1.5.0,!=1.6.4,!=1.7.3,!=1.8.0
10+
sphinx>=1.8.1
1111
colorspacious
1212
ipython
1313
ipywidgets

0 commit comments

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