Skip to content

DOC: fix code-block ipython highlighting #12853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

jorisvandenbossche
Copy link
Member

I noticed some warnings in the travis doc build log in the sense of "WARNING: Could not parse literal_block as "python". highlighting skipped."
This was because some of the .. code-block:: python directives contained code that could not be interpreted as python. And, additionally, these code blocks were also not highlighted correctly (the In [1] prompt were not recognized by the default python highlighter).

Therefore, I changed those .. code-block:: python directives containing IPython prompt to .. code-block:: ipython

@jreback
Copy link
Contributor

jreback commented Apr 10, 2016

oh, this fixes it great!

@jreback jreback added the Docs label Apr 10, 2016
@jreback jreback added this to the 0.18.1 milestone Apr 10, 2016
@jorisvandenbossche jorisvandenbossche force-pushed the fix-ipython-highlighting branch from 7bb8df3 to 1e104cc Compare April 10, 2016 20:38
@jorisvandenbossche
Copy link
Member Author

Fixed the merge conflict.

So in the future, when using a code-block that includes some IPython In []/Out [] prompts, we should use ipython, and otherwise python is OK (although actually in that case you can also use just :: as python is the default)

@jreback
Copy link
Contributor

jreback commented Apr 11, 2016

@jorisvandenbossche lgtm.

@jorisvandenbossche jorisvandenbossche deleted the fix-ipython-highlighting branch April 11, 2016 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants