supabase / vecs

Postgres/pgvector Python Client
https://supabase.github.io/vecs/latest
Apache License 2.0
219 stars 33 forks source link

Doc versioning #43

Closed olirice closed 1 year ago

olirice commented 1 year ago

What kind of change does this PR introduce?

Add versioning and a version selector to docs via mike

This change allows

Deployment

Initial Setup

On initial setup, delete existing docs

mike delete --all

Build docs locally under a version name and an alias

mike deploy --update-aliases 0.3 latest

add --push to deploy to GitHub Pages

Build docs locally without an alias

mike deploy 0.3

Serve docs locally

mike serve

Set default version

mike set-default 0.3

See preview

olirice commented 1 year ago

could you check if

pip install -e '.[docs]'

works for you?

egor-romanov commented 1 year ago

could you check if

pip install -e '.[docs]'

works for you?

Yep, works 👍