8000 Clean Up How Current Pyodide Version is Specified · Issue #1349 · pyscript/pyscript · GitHub
[go: up one dir, main page]
Skip to content

Clean Up How Current Pyodide Version is Specified #1349

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
Closed
JeffersGlass opened this issue Apr 1, 2023 · 7 comments
Closed

Clean Up How Current Pyodide Version is Specified #1349

JeffersGlass opened this issue Apr 1, 2023 · 7 comments
Labels
tag: docs Related to the documentation tag: pyodide Related to issues with pyodide

Comments

@JeffersGlass
Copy link
Contributor

As @hood commented on #1346, the version number and URL for the version of Pyodide we're using is specified in roughly a dozen places throughout the docs and source at the moment. It would be nice to only specify Pyodide:

  • one time in the changelog
  • one time in the docs
  • one time in environment.yml
  • one time in package.json

so that there are only four edits needed to bump the version of Pyodide.
@JeffersGlass JeffersGlass added tag: docs Related to the documentation tag: pyodide Related to issues with pyodide labels Apr 1, 2023
@JeffersGlass JeffersGlass mentioned this issue Apr 1, 2023
Merged
3 tasks
@jameshiebert
Copy link

I have a branch that starts on this, but am running into a pain of a roadblock.

The the MyST substitution rules are not assessed within code blocks, and code blocks contain the vast majority of the usage of the pyodide version number.

Any advice for how to work around this or other ways to inject substitutions aside from myst_substitutions?

@JeffersGlass
Copy link
Contributor Author

I haven't tried it out myself, but sphinx substitution extensions looks promising. It's not entirely clear to me whether it with code fences and not just blocks... might be worth a play though.

@jameshiebert
Copy link

Yeah, that looked promising, though I can't get it to work. Since most of the docs are written in markdown, I suspect that they get bypassed the Sphinx substitution.

@JeffersGlass
Copy link
Contributor Author

Hmmm yeah, it looks like there's an open PR from a couple years ago on that extension about extending it to markdown/code fences, that never got finished...

@hoodmane
Copy link
Contributor

Looks like a pretty small patch, so maybe we could pick it up and finish it.

@JeffersGlass
Copy link
Contributor Author

The docs have moved elsewhere, and the default version of Pyodide is set by the version of Polyscript we import. I think the only place where versioning issues may live on is in the examples, and that's being handled/tracked by #1798. Closing as obsolete.

@adamtheturtle
Copy link

@JeffersGlass The latest release of sphinx-substitution-extensions now has support for code-block with MyST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
tag: docs Related to the documentation tag: pyodide Related to issues with pyodide
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@adamtheturtle @JeffersGlass @jameshiebert @hoodmane
0