Skip to content

docs: document that %burr_ui shows the UI in an iframe by default - #994

Open
hifarrer wants to merge 1 commit into
apache:mainfrom
hifarrer:docs/burr-ui-notebook-magic
Open

hifarrer wants to merge 1 commit into
apache:mainfrom
hifarrer:docs/burr-ui-notebook-magic

Conversation

@hifarrer

Copy link
Copy Markdown

Corrects the notebook docs for the %burr_ui magic. It says it prints the URL of the UI, but since the iframe support (d0db4e8, Nov 2024) it embeds the UI below the cell and only prints the URL with --no-iframe. Related to #272 (it does not close it).

Changes

  • docs/ui/notebook.rst: describe the iframe default, the background server on port 7241 that later calls reuse, and the --height/-h and --no-iframe options.
  • docs/concepts/tracking.rst: correct the intro and the example, and link to the notebook page.

How I tested this

Checked with Claude Code, which ran these on Windows 11 / Python 3.13:

  • Ran %burr_ui in a real Jupyter kernel against the released apache-burr 0.43.0. It showed an iframe with height 400. --height 600 and -h 555 changed the height. --no-iframe printed Burr UI: http://127.0.0.1:7241. Repeated calls reused the same server process.
  • Built the docs with the CI command (python -m sphinx -T -W --keep-going -b dirhtml ...). It passes before and after, and I read the rendered HTML of both sections.
  • pre-commit run --all-files gives the same result before and after. The changed files pass. Black fails on two example files I did not touch, and it fails the same way on main.

Notes

  • The Colab snippet is unchanged and untested. It may no longer be needed, because the code puts Colab's proxied URL in the iframe.
  • The sentence about the server restarting if its process exited is from reading burr/integrations/notebook.py, not from running it.
  • Separate from this PR: the magic starts the server with a bare python. On my Windows setup that picked an interpreter without burr, so the iframe stayed blank. That is tracked in Notebook UI launcher should use the current Python interpreter #981 / fix(notebook): launch UI with current Python interpreter #982 and is not fixed here.
  • This text was drafted with Claude Code and reviewed by me.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested (N/A, docs only)
  • New functions are documented (with a description, list of inputs, and expected output) (N/A, no code)
  • Placeholder code is flagged / future TODOs are captured in comments (N/A, no code)
  • Project documentation has been updated if adding/changing functionality.

The notebook docs said the %burr_ui magic prints the URL of the UI. Since
the iframe support was added it embeds the UI below the cell instead, and
only prints the URL with --no-iframe.

- docs/ui/notebook.rst: describe the iframe default, the background server
  on port 7241 that later calls reuse, and the --height/-h and --no-iframe
  options.
- docs/concepts/tracking.rst: correct the intro and the example, and link
  to the notebook page.
@github-actions github-actions Bot added the area/website burr.apache.org website label Oct 24, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant