Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ docs/
│ │ └── gui_components.md
│ └── client/ # Client development guide
│ ├── index.md
│ ├── basic_usage.md
│ ├── client.md
│ ├── parameters_and_methods.md
│ └── advanced_patterns.md
Expand All @@ -92,6 +92,7 @@ The documentation uses the **pydata-sphinx-theme**, which provides:
- Light/dark mode support
- Mobile-friendly navigation
- Integrated search
- Copy buttons on code examples

## Contributing to Documentation

Expand Down Expand Up @@ -145,4 +146,4 @@ Commits to the main branch trigger automatic builds.

- [Sphinx Documentation](https://www.sphinx-doc.org/)
- [MyST Parser](https://myst-parser.readthedocs.io/)
- [PyData Theme](https://pydata-sphinx-theme.readthedocs.io/)
- [PyData Theme](https://pydata-sphinx-theme.readthedocs.io/)
410 changes: 410 additions & 0 deletions docs/_static/animations/proxy_lifecycle.html

Large diffs are not rendered by default.

13 changes: 11 additions & 2 deletions docs/_static/animations/request_flow.html
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,15 @@ <h3>Subscribers react</h3>
applyStep(index);
}

function selectStep(index) {
var step = stepEls[index];
if (!step) return;
setActive(index);
var rect = step.getBoundingClientRect();
var target = window.scrollY + rect.top + rect.height / 2 - window.innerHeight * 0.57;
window.scrollTo({ top: Math.max(0, target), behavior: reduced ? "auto" : "smooth" });
}

root.classList.add("is-live");

/* Cards are direct controls as well as scroll markers. Keep their activation
Expand All @@ -826,11 +835,11 @@ <h3>Subscribers react</h3>
"aria-label",
"Show " + STEPS[index].no + ": " + (title ? title.textContent : STEPS[index].title)
);
card.addEventListener("click", function () { setActive(index); });
card.addEventListener("click", function () { selectStep(index); });
card.addEventListener("keydown", function (event) {
if (event.key === "Enter" || event.key === " ") {
event.preventDefault();
setActive(index);
selectStep(index);
}
});
});
Expand Down
12 changes: 11 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
'nbsphinx', # Jupyter notebook support
'sphinx.ext.intersphinx', # Link to other project docs
'sphinx_design', # Tabs, cards, grids
'sphinx-prompt', # Copy-safe shell and interpreter prompts
'sphinx_copybutton', # Copy buttons on code blocks
]

# MyST Parser configuration
Expand Down Expand Up @@ -67,6 +69,14 @@
nbsphinx_allow_errors = True # Continue building if notebook has errors
nbsphinx_kernel_name = 'python3'

# Match scikit-learn's copy behavior: remove Python REPL prompts and the inline
# styles used to draw unselectable sphinx-prompt prefixes. Keep copy buttons off
# notebook prompts and line-number gutters.
copybutton_prompt_text = r">>> |\.\.\. "
copybutton_prompt_is_regexp = True
copybutton_exclude = "style"
copybutton_selector = ":not(.prompt) > div.highlight pre"

# Intersphinx configuration (link to other docs)
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
Expand Down Expand Up @@ -127,4 +137,4 @@
# HTML context for custom variables
html_context = {
"default_mode": "auto" # Light/dark theme
}
}
2 changes: 1 addition & 1 deletion docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ This single entry only scratches the surface of what the config file controls; t
You've seen the whole loop: a Server owning instruments, clients reaching them through
Proxy Instruments, and every change broadcast to anyone watching. From here:

- [Basic usage](../user_guide/basic_usage.md): the Python client in depth, the
- [Python Client](../user_guide/client.md): the Python client in depth, the
interface you'll use the most.
- [The server](../user_guide/server.md): launch options, headless operation, and the
Detached GUI.
Expand Down
14 changes: 0 additions & 14 deletions docs/user_guide/basic_usage.md

This file was deleted.

Loading
Loading