Skip to content

docs: upgrade theme styling, auto API refs, and notebook CSS#9

Merged
FBumann merged 2 commits intomainfrom
docs/upgrade-styling
Mar 24, 2026
Merged

docs: upgrade theme styling, auto API refs, and notebook CSS#9
FBumann merged 2 commits intomainfrom
docs/upgrade-styling

Conversation

@FBumann
Copy link
Copy Markdown
Owner

@FBumann FBumann commented Mar 24, 2026

Summary

  • Rich navigation: instant loading, tabs, breadcrumbs, back-to-top, progress bar, URL tracking
  • Auto-generated API reference: gen-files + literate-nav scan src/ and create API docs from docstrings
  • Extended markdown: mermaid diagrams, emoji, footnotes, definition lists, inline highlighting, snippets, abbreviations
  • Custom color scheme: green/teal palette with light/dark mode via CSS variables
  • Notebook support: mkdocs-jupyter plugin with execute enabled, polished cell styling (hidden prompts, styled code backgrounds, dark mode)
  • Quickstart notebook: minimal example notebook under docs/notebooks/
  • nbstripout: pre-commit hook to strip notebook outputs before committing
  • Better mkdocstrings config: separate signatures, symbol type headings, annotation display

Test plan

  • Run mkdocs serve and verify navigation tabs, instant loading, dark/light toggle
  • Check auto-generated API Reference tab populates from src/
  • Verify custom colors render in both light and dark mode
  • Verify quickstart notebook renders with clean cell styling

🤖 Generated with Claude Code

…otebook styling

Add polished Material theme features (instant nav, tabs, breadcrumbs, search
highlighting), auto-generated API reference via gen-files/literate-nav, extended
markdown extensions (mermaid, emoji, footnotes, etc.), custom color scheme, and
clean Jupyter notebook cell styling with dark mode support.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 24, 2026

Warning

Rate limit exceeded

@FBumann has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 15 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ec568c56-263b-4ec5-8810-2facc265cb19

📥 Commits

Reviewing files that changed from the base of the PR and between 4ef1d24 and e469e56.

📒 Files selected for processing (6)
  • .pre-commit-config.yaml
  • docs/gen_ref_pages.py
  • docs/notebooks/quickstart.ipynb
  • docs/stylesheets/extra.css
  • mkdocs.yml
  • pyproject.toml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/upgrade-styling

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

…hook

Add a minimal quickstart notebook under docs/notebooks/, enable the
mkdocs-jupyter plugin for notebook rendering, add mkdocs-jupyter to docs
dependencies, and add nbstripout pre-commit hook for notebook hygiene.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@FBumann FBumann merged commit 28df5e8 into main Mar 24, 2026
11 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.

1 participant