[DOCS] Fix Queries page rendering raw notebook JSON#112
Merged
Conversation
The mkdocs-jupyter plugin built docs/queries.ipynb at the same URL as queries.md, and with the i18n plugin the raw notebook JSON won the collision on the published site. Move the notebook to notebooks/ and drop the now-unused mkdocs-jupyter plugin so only queries.md is built. Fixes #111
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
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.
What changes were proposed in this PR?
The published Queries page at https://sedona.apache.org/spatialbench/queries/ shows the raw JSON of
docs/queries.ipynbinstead of the rendered documentation.Both
docs/queries.ipynbanddocs/queries.mdbuilt to the same/queries/URL. With themkdocs-jupyterplugin enabled alongside thei18nplugin (docs_structure: suffix), the i18n plugin copies the notebook into the site as-is over the rendered markdown page, so the raw notebook JSON wins the collision. This reproduces locally withmkdocs buildonmain, even withmkdocs-jupyterproperly installed.This PR:
docs/queries.ipynbtonotebooks/queries.ipynbso it stays in the repo as a runnable artifact but is no longer a buildable docs pagemkdocs-jupyterplugin frommkdocs.ymlanddocs/requirements.txt(the notebook was the only.ipynbunderdocs/), so the collision cannot recurVerified locally:
mkdocs buildsucceeds and the queries page now renders the proper markdown (Q1–Q12 with descriptions, SQL, and result tables) in both English and Chinese, with no notebook JSON on the page.Fixes #111
How was this change tested?
Built the site locally with
mkdocs build:main,queries/index.htmlcontains 32 occurrences of raw"cell_type"JSON (bug reproduced)zh/queries/builds correctly too