Skip to content

use sidebar for docs navigation#19

Merged
eutwt merged 5 commits intomainfrom
benchmark-pyversus-only
Jan 4, 2026
Merged

use sidebar for docs navigation#19
eutwt merged 5 commits intomainfrom
benchmark-pyversus-only

Conversation

@eutwt
Copy link
Copy Markdown
Owner

@eutwt eutwt commented Jan 4, 2026

Summary

  • Rename the landing page to Overview and simplify the root toctree for the sidebar.
  • Force the left nav on all pages with a custom template and shorten link labels in the nav.
  • Hide top nav links and right-align the remaining header controls.

Testing

  • uv run pytest
  • UV_CACHE_DIR=.uv_cache UV_TOOL_DIR=.uv_tools uvx ty check
  • uv run ruff check --select I --fix python tests scripts
  • uv run ruff check python tests scripts
  • uv run ruff format python tests scripts

eutwt added 5 commits January 3, 2026 16:41
Replace static chart embeds with a canvas renderer that draws lines/points directly on the page, provides hover tooltips, and re-renders immediately when the theme toggles via a data-theme observer.

Introduce theme-aware chart styling through CSS variables for axis/grid/label and series colors, tuned to stay brand-adjacent while improving contrast in both light and dark modes.

Improve chart readability by increasing axis/tick typography and expanding plot margins to avoid label overlap.

Rewrite the benchmark page to be user-facing (describe the dataset and comparison setup), remove run instructions and the results table now that interactive hovers show values.

Move Errors/Examples/Benchmark into the More dropdown by lowering header_links_before_dropdown and placing those entries after the primary links.
Add a TypeScript source for the benchmark charts and regenerate the JS output for the docs site.

Format memory ticks/tooltip with MB or GB, shorten row counts in tooltips, and trim time tooltip precision while keeping axis ticks labeled in seconds.

Update the benchmark page labels and wording to match the new axis units and R vignette description.
- Rename the landing page to Overview and simplify the root toctree to use self + reference/index, matching the left-nav structure (getting-started renamed to Install & basics).

- Add a dedicated sidebar template that renders the full global toctree from level 0, expands reference pages further, and labels the section like Polars.

- Strip the "versus." prefix from sidebar link text at render time to prevent truncation in the left nav while preserving actual URLs.

- Force the sidebar template on all pages via html_sidebars so the nav is always visible (no hide-on-wide behavior).

- Hide top navbar links and right-align the remaining header controls to keep search/theme aligned after removing the top nav links.
- drop the HTML post-processing for sidebar labels and use an autosummary method template so method pages render as Comparison.* without the versus. prefix

- restore the GitHub icon link via theme options and place header controls on the right without duplicate search

- remove the brittle nav-hiding CSS while keeping header alignment adjustments

- note the benchmark machine (2020 13-inch MacBook Pro, i7, 32 GB RAM) on the benchmarks page
@eutwt eutwt changed the title Align docs navigation with Polars-style sidebar use sidebar for docs navigation Jan 4, 2026
@eutwt eutwt merged commit c5f24bd into main Jan 4, 2026
7 checks passed
github-actions bot added a commit that referenced this pull request Jan 4, 2026
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.

1 participant