Replace recommonmark with myst#7237
Closed
dnskr wants to merge 1 commit into
Closed
Conversation
Signed-off-by: dnskr <dnskrv88@gmail.com>
pan3793
approved these changes
Nov 3, 2025
Member
|
oh, wait, have you checked the configuration page? I remember there were some css issues in my previous attempts |
Contributor
Author
I can't find any difference. Do you remember what the issue was? master docs PR docs |
cxzl25
approved these changes
Nov 7, 2025
turboFei
approved these changes
Nov 7, 2025
dnskr
added a commit
that referenced
this pull request
Nov 7, 2025
### Why are the changes needed? The PR replaces deprecated [recommonmark](https://github.com/readthedocs/recommonmark) (last release on December 17, 2020) with recommended [MyST](https://github.com/executablebooks/MyST-Parser) to generate documentation from markdown. Sphinx documentation also assumes that MyST is used. ### How was this patch tested? Build the docs with the following command, and verify that the pages generated from the markdown files look the same: ```shell make html ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes #7237 from dnskr/replace-recommonmark-with-myst. Closes #7237 dd26410 [dnskr] Replace recommonmark with myst Authored-by: dnskr <dnskrv88@gmail.com> Signed-off-by: dnskr <dnskrv88@gmail.com> (cherry picked from commit bebe10a) Signed-off-by: dnskr <dnskrv88@gmail.com>
Closed
dnskr
added a commit
that referenced
this pull request
Mar 23, 2026
### Why are the changes needed? The PR fixes broken links in the documentation. Some links broke after [replacing recommonmark with myst](#7237), while others (like [kyuubi 1.9.4/aqe](https://kyuubi.readthedocs.io/en/v1.9.4/deployment/spark/aqe.html#:~:text=Configuring%20by%20spark%2Ddefaults.conf)) used incorrect paths and were already broken before the change. ### How was this patch tested? Built the documentation with the following command and verified the fixed links manually: ```shell make html ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes #7365 from dnskr/docs-fix-links. Closes #7365 9dcbeed [Denis Krivenko] [DOC] Fix links Authored-by: Denis Krivenko <dnskrv88@gmail.com> Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
dnskr
added a commit
that referenced
this pull request
Mar 23, 2026
### Why are the changes needed? The PR fixes broken links in the documentation. Some links broke after [replacing recommonmark with myst](#7237), while others (like [kyuubi 1.9.4/aqe](https://kyuubi.readthedocs.io/en/v1.9.4/deployment/spark/aqe.html#:~:text=Configuring%20by%20spark%2Ddefaults.conf)) used incorrect paths and were already broken before the change. ### How was this patch tested? Built the documentation with the following command and verified the fixed links manually: ```shell make html ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes #7365 from dnskr/docs-fix-links. Closes #7365 9dcbeed [Denis Krivenko] [DOC] Fix links Authored-by: Denis Krivenko <dnskrv88@gmail.com> Signed-off-by: Denis Krivenko <dnskrv88@gmail.com> (cherry picked from commit 7969f85) Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Why are the changes needed?
The PR replaces deprecated recommonmark (last release on December 17, 2020) with recommended MyST to generate documentation from markdown. Sphinx documentation also assumes that MyST is used.
How was this patch tested?
Build the docs with the following command, and verify that the pages generated from the markdown files look the same:
Was this patch authored or co-authored using generative AI tooling?
No