Skip to content

[DOCS] Fix Queries page rendering raw notebook JSON#112

Merged
jiayuasu merged 1 commit into
mainfrom
queries-page-notebook-collision
Jun 12, 2026
Merged

[DOCS] Fix Queries page rendering raw notebook JSON#112
jiayuasu merged 1 commit into
mainfrom
queries-page-notebook-collision

Conversation

@jiayuasu

Copy link
Copy Markdown
Member

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.ipynb instead of the rendered documentation.

Both docs/queries.ipynb and docs/queries.md built to the same /queries/ URL. With the mkdocs-jupyter plugin enabled alongside the i18n plugin (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 with mkdocs build on main, even with mkdocs-jupyter properly installed.

This PR:

  • Moves docs/queries.ipynb to notebooks/queries.ipynb so it stays in the repo as a runnable artifact but is no longer a buildable docs page
  • Removes the mkdocs-jupyter plugin from mkdocs.yml and docs/requirements.txt (the notebook was the only .ipynb under docs/), so the collision cannot recur

Verified locally: mkdocs build succeeds 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:

  • On main, queries/index.html contains 32 occurrences of raw "cell_type" JSON (bug reproduced)
  • With this change, the page contains the rendered markdown and zero notebook JSON; zh/queries/ builds correctly too

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
@jiayuasu jiayuasu merged commit be2c10f into main Jun 12, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Queries docs page renders raw notebook JSON instead of formatted content

1 participant