/matplotlib

DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 #8086

Merged
merged 1 commit into from Feb 17, 2017
+2 −1

Conversation

Reviewers

@NelleV NelleV

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
  v2.0.1
4 participants
@mitya57 @NelleV @tacaswell @dstansby
@mitya57
Contributor

mitya57 commented Feb 16, 2017

With Sphinx 1.5, this is needed by searchtools.js to display the source snippets (see sphinx-doc/sphinx#2454, and especially sphinx-doc/sphinx@71dd8bf).

With earlier Sphinx versions, this is a no-op because the undefined variable will evaluate to an empty string.
@mitya57 mitya57 DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 
With Sphinx 1.5, this is needed by searchtools.js to display the source
snippets (see sphinx-doc/sphinx#2454).

With earlier Sphinx versions, this is a no-op because the undefined variable
will evaluate to an empty string.

Some checks were not successful

1 failing and 4 successful checks
continuous-integration/appveyor/pr — AppVeyor build failed
Details
codecov/patch — Coverage not affected when comparing 0cab7c6...53e6bc4
Details
codecov/project/library — 62.22% remains the same compared to 0cab7c6
Details
codecov/project/tests — 97.94% (target 97.7%)
Details
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
53e6bc4

dstansby added the Documentation label Feb 16, 2017

@NelleV
Contributor

NelleV commented Feb 16, 2017

wow, that is an annoying change on the behalf of sphinx… It should be taken care of out of the box.

NelleV changed the title from DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 to [MRG+1] DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 Feb 16, 2017

@NelleV

NelleV approved these changes Feb 16, 2017
View changes

👍

Thanks @mitya57 !

@tacaswell tacaswell merged commit de72808 into matplotlib:master Feb 17, 2017
4 of 5 checks passed

4 of 5 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
codecov/patch Coverage not affected when comparing 0cab7c6...53e6bc4
Details
codecov/project/library 62.22% remains the same compared to 0cab7c6
Details
codecov/project/tests 97.94% (target 97.7%)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@tacaswell tacaswell added a commit that referenced this pull request Feb 17, 2017

@tacaswell tacaswell Merge pull request #8086 from mitya57/master 
DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5
 1cce7d3
@tacaswell
Owner

tacaswell commented Feb 17, 2017

Thanks, backported to v2.0.0-doc as 1cce7d3

tacaswell added this to the 2.0.1 (next bug fix release) milestone Feb 17, 2017

QuLogic changed the title from [MRG+1] DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 to DOC: add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 Feb 17, 2017

QuLogic referenced this pull request Feb 20, 2017

Closed

Some searches in documentation result in no results #5320

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment