Skip to content

Refresh documentation for the current API#7

Merged
TheodoreWolf merged 2 commits into
mainfrom
theo/refresh-docs
Jul 17, 2026
Merged

Refresh documentation for the current API#7
TheodoreWolf merged 2 commits into
mainfrom
theo/refresh-docs

Conversation

@TheodoreWolf

@TheodoreWolf TheodoreWolf commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • rewrite the README around the current Random, Grid, and Bayesian search APIs, including accurate batch/buffer semantics, executable examples, JAX constraints, and contributor commands
  • add a focused Sphinx usage guide and refresh the optimizer, search-space, acquisition, kernel, and notebook reference pages
  • use the README's canonical transparent logo in the Sphinx theme
  • remove stale generated API pages that refer to classes which no longer exist
  • derive the documentation version from the installed package and remove unused MyST/nbsphinx build dependencies

Verification

  • uv run pytest -m 'not timing' -q — 184 passed, 2 deselected
  • uv run sphinx-build -W --keep-going -E -a -b html docs/source docs/build/html-main
  • parsed every README Python block and executed the quick-start example as written
  • verified the rebuilt and live-served theme loads the canonical 949×579 assets/logo-transparent.png

@TheodoreWolf TheodoreWolf changed the title Add TPE and CARBS optimizers and refresh documentation Refresh documentation for the current API Jul 17, 2026
@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@TheodoreWolf
TheodoreWolf merged commit 9e29502 into main Jul 17, 2026
4 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