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.

Sign up for GitHub

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

Jump to bottom

nbconvert from Ubuntu packages is not suitable for GitHub Pages #4651

Closed
jngrad opened this issue Jan 13, 2023 · 0 comments · Fixed by #4656
Closed

nbconvert from Ubuntu packages is not suitable for GitHub Pages #4651

jngrad opened this issue Jan 13, 2023 · 0 comments · Fixed by #4656
Assignees
@jngrad
Labels
DevOps

Comments

@jngrad
Copy link
Member

jngrad commented Jan 13, 2023 •
edited
Loading

The nbconvert package provides sensible default configuration options for the HTMLExporter class, which can be overridden by a custom derived class if so desired (documentation).

By default, HTMLExporter.mathjax_url points to https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js and HTMLExporter.require_js_url points to https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/require.min.js. In the Ubuntu package, these default paths have been replaced by file:///usr/share/javascript/mathjax/MathJax.js resp. file:///usr/share/javascript/requirejs/require.min.js. These URIs cannot be resolved in a web browser when the HTML page is served from e.g. GitHub Pages.

As a result, tutorials currently deployed to https://espressomd.github.io/tutorials.html don't have access to MathJax and cannot typeset their mathematical equations.

Solution: either write and maintain a custom derived HTMLExporter class, or re-install nbconvert in the dockerfile from pypi with python3 -m pip install --user 'nbconvert>6.4.0,<6.5' to recover the upstream default values.
@jngrad jngrad added the DevOps label Jan 13, 2023
@jngrad jngrad mentioned this issue Jan 17, 2023
Merged
@jngrad jngrad self-assigned this Jan 17, 2023
@jngrad jngrad mentioned this issue Jan 20, 2023
Merged
@kodiakhq kodiakhq bot closed this as completed in #4656 Jan 23, 2023
kodiakhq bot added a commit that referenced this issue Jan 23, 2023
@kodiakhq
Fix tutorial deployment to GitHub Pages (#4656)
ec6caa2 
Fixes #4651

Description of changes:
- use cloud providers to fetch JavaScript dependencies
- cleanup test cases involved in the tutorial toolchain
jngrad pushed a commit to jngrad/espresso that referenced this issue Mar 2, 2023
@kodiakhq @jngrad
Fix tutorial deployment to GitHub Pages (espressomd#4656)
1e4f0e9 
Fixes espressomd#4651

Description of changes:
- use cloud providers to fetch JavaScript dependencies
- cleanup test cases involved in the tutorial toolchain
jngrad pushed a commit to jngrad/espresso that referenced this issue Mar 2, 2023
@kodiakhq @jngrad
Fix tutorial deployment to GitHub Pages (espressomd#4656)
f625b50 
Fixes espressomd#4651

Description of changes:
- use cloud providers to fetch JavaScript dependencies
- cleanup test cases involved in the tutorial toolchain
jngrad pushed a commit to jngrad/espresso that referenced this issue Mar 2, 2023
@kodiakhq @jngrad
Fix tutorial deployment to GitHub Pages (espressomd#4656)
f079bb8 
Fixes espressomd#4651

Description of changes:
- use cloud providers to fetch JavaScript dependencies
- cleanup test cases involved in the tutorial toolchain
jngrad pushed a commit to jngrad/espresso that referenced this issue Mar 2, 2023
@kodiakhq @jngrad
Fix tutorial deployment to GitHub Pages (espressomd#4656)
56a2172 
Fixes espressomd#4651

Description of changes:
- use cloud providers to fetch JavaScript dependencies
- cleanup test cases involved in the tutorial toolchain
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jngrad jngrad

Labels
DevOps
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix tutorial deployment to GitHub Pages jngrad/espresso
1 participant
@jngrad