docs: add dedicated Burr UI server documentation (issue #272)#810
Open
enu-emu wants to merge 2 commits into
Open
docs: add dedicated Burr UI server documentation (issue #272)#810enu-emu wants to merge 2 commits into
enu-emu wants to merge 2 commits into
Conversation
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.
Summary
Closes #272
docs/concepts/ui.rstwith a full guide to the Burr UI server: installation, CLI options (with examples), demo data walkthrough, step-by-step descriptions of every UI feature, notebook/Colab launch, FastAPI embedding, and how to wire up tracking so your app appears in the UIdocs/concepts/index.rstunder the Concepts toctree, positioned aftertrackingWhat's in the new page
pip install "apache-burr[start]"with a note on the Python 3.13 / pandas compatibility fix--port,--host,--no-open,--no-copy-demo_data,--backend, and--dev-modewith usage examples%burr_uimagic with Google Colab instructionsmount_burr_uiexample.with_tracker()setup with a cross-reference totrackingTesting
make htmlindocs/— Sphinx build passes, zero new warnings from the new filesburr --help