ReadTheDocs rendering fixes #490
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some part of the ipynb->HTML conversion process does not like text wrapped in triple asterisks. In particular, it inserts literal "nbsphinx-math" text into the output. For example, a line like this in a markdown cell: ***rvu -vf views\\front.vp -e .01 tutorial_1.oct*** Ends up displaying as the following text (styled bold) when viewing the output HTML: rvu -vf views:nbsphinx-math:`front`.vp -e .01 tutorial_1.oct I couldn't find a way to disable this behavior, including trying different/newer versions of nbsphinx and pandoc, so instead I just replace the triple asterisks with double asterisks in the source ipynb files using this command: git grep -l '\*\*\*.*\*\*\*' *.ipynb | xargs -d '\n' sed -i 's/\*\*\*/\*\*/g'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to #489. Some of the example notebooks use text wrapped in
***for emphasis, which for some reason results in messed up HTML output. Here an example from Tutorial 1:This PR replaces those triple asterisks with double asterisks,
which I think should render as expected. Edit: no they don't. Exploring alternatives...It also fixes a title underline issue on the examples page.