Skip to content
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

fix: add IPython as Sphinx extension #1966

Merged
merged 3 commits into from
Dec 6, 2022

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented Dec 6, 2022

This PR fixes the root cause that motivated #1964. In fact, the problem was exclusively on RTD, but when I checked my original fix, I checked the CI build result (which has not shown this highlighting problem).

This PR adds IPython as a Sphinx extension, and reverts the changes to the code-cell language.


📚 The documentation for this PR will be available at https://awkward-array.readthedocs.io/en/agoose77-docs-fix-syntax-highlighting/ once Read the Docs has finished building 🔨

@agoose77 agoose77 changed the title fix: add IPython to requirements fix: add IPython as Sphinx extension Dec 6, 2022
Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see a difference in syntax coloring between

https://awkward-array.readthedocs.io/en/main/reference/generated/ak.cartesian.html

and

https://awkward-array.readthedocs.io/en/agoose77-docs-fix-syntax-highlighting/reference/generated/ak.cartesian.html

but I guess the distinction would be in the %magic commands (IPython vs Python).

But this has my approval and can be merged when you're ready.

@jpivarski
Copy link
Member

The last message was an hour ago, so I guess you're done with this PR. Half the tests didn't run because it's a documentation-only change. I'll press the red button and merge it.

@jpivarski jpivarski merged commit 73804b6 into main Dec 6, 2022
@jpivarski jpivarski deleted the agoose77/docs-fix-syntax-highlighting branch December 6, 2022 19:53
@agoose77
Copy link
Collaborator Author

agoose77 commented Dec 6, 2022

@jpivarski this PR is fixing the user guide, whose code cells are unstyled in the RTD main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants