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

Update myst-parser version for docs #17778

Merged
merged 1 commit into from
Jun 14, 2023
Merged

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Jun 6, 2023

Description

Update myst-parser used in the docker container for builds to the new 1.0.0 release (from 0.18). This brings a bunch of improvements that are needed for the upgrade to markdown source for all the docs.

See https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html

For this to be merged @electrum needs to build the container locally and push it to the ghcr with the updated 5.1 version. You can test this locally as well if desired with building the container and using SPHINX_IMAGE

Also note that GHA build will fail until the container is published. And we need to make sure we publish it as a dual processor architecture container as well so it performs well for x86 and arm/m1. Any tips how you did that last time @electrum ?

I ran full site build with old and new version and the output HTML is identical.

Additional context and related issues

This PR will help advance #17759 and follow up work.

Release notes

(x) This is not user-visible or docs only and no release notes are required.
( ) Release notes are required, please propose a release note for me.
( ) Release notes are required, with the following suggested text:

@cla-bot cla-bot bot added the cla-signed label Jun 6, 2023
@mosabua mosabua requested a review from electrum June 6, 2023 22:52
@mosabua mosabua marked this pull request as ready for review June 6, 2023 22:53
@github-actions github-actions bot added the docs label Jun 7, 2023
@mosabua
Copy link
Member Author

mosabua commented Jun 13, 2023

@electrum published the container and we updated the version. All works now. Once approved I will merge.

docs/build Show resolved Hide resolved
@mosabua mosabua merged commit 0548160 into trinodb:master Jun 14, 2023
@mosabua mosabua deleted the mm/myst branch June 14, 2023 19:24
@github-actions github-actions bot added this to the 420 milestone Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants