Skip to content

Turn off syntax highlighting in one of the known issues#4547

Merged
astrofrog merged 2 commits intoastropy:masterfrom
mwcraig:fix-known-issue-warning
Jan 31, 2016
Merged

Turn off syntax highlighting in one of the known issues#4547
astrofrog merged 2 commits intoastropy:masterfrom
mwcraig:fix-known-issue-warning

Conversation

@mwcraig
Copy link
Member

@mwcraig mwcraig commented Jan 30, 2016

Several recent doc builds have failed because the most recent release of sphinx made this change[1]:

1565: Sphinx will now emit a warning that highlighting was skipped if the syntax is incorrect for code-block, literalinclude and so on.

The known issue at https://github.com/astropy/astropy/blob/master/docs/known_issues.rst#L324 contains u.Angstrom? because the issue was in IPython. Because the question mark isn't standard python syntax, sphinx now generates a warning, which fails the test.

@eteq @astrofrog -- how should this be milestoned?

[1]: Release 1.3.5 (released Jan 24, 2016)

@astrofrog
Copy link
Member

@mwcraig - thanks! Would it work if we instead updated the prompt in the example to IPython instead of >>>?

@mwcraig
Copy link
Member Author

mwcraig commented Jan 30, 2016

@astrofrog -- somewhat to my surprise, yes, locally...will see what travis says.

@astrofrog
Copy link
Member

@mwcraig - thanks!

astrofrog added a commit that referenced this pull request Jan 31, 2016
Turn off syntax highlighting in one of the known issues
@astrofrog astrofrog merged commit 12e9367 into astropy:master Jan 31, 2016
@astrofrog astrofrog added this to the v1.0.9 milestone Jan 31, 2016
@astrofrog
Copy link
Member

I'm milestoning as v1.0.x because we do still rely on Travis for that branch, so this will need to be fixed there too.

eteq pushed a commit that referenced this pull request Feb 24, 2016
Turn off syntax highlighting in one of the known issues
eteq pushed a commit that referenced this pull request Feb 29, 2016
Turn off syntax highlighting in one of the known issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants