chore: add generated docs for python API #785
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alejandrodnm
temporarily deployed
to
internal-contributors
GitHub Actions
Inactive
alejandrodnm
force-pushed
the
adn/pydoc-md
branch
from
d48ee36 to
8c9c27a
Compare
alejandrodnm
temporarily deployed
to
internal-contributors
GitHub Actions
Inactive
alejandrodnm
force-pushed
the
adn/pydoc-md
branch
from
8c9c27a to
dcfa205
Compare
alejandrodnm
temporarily deployed
to
internal-contributors
GitHub Actions
Inactive
alejandrodnm
commented
Jun 5, 2025
| UV_PROJECT_ENVIRONMENT=/usr/local/ | ||
| WORKDIR /build | ||
| COPY --from=ghcr.io/astral-sh/uv:0.5.20 /uv /uvx /bin/ | ||
| COPY --from=ghcr.io/astral-sh/uv:0.7.10 /uv /uvx /bin/ |
Collaborator
Author
There was a problem hiding this comment.
@JamesGuthrie should I change this as well?
JamesGuthrie
reviewed
Jun 5, 2025
Member
JamesGuthrie
left a comment
JamesGuthrie
left a comment
There was a problem hiding this comment.
TBH the vectorizer api documentation is not useful. Especially when compared with what we have in https://github.com/timescale/pgai/blob/main/docs/vectorizer/api-reference.md.
IMHO we would need to tweak it quite a bit in order to provide the same level of experience as what we have for the sql API.
Add the command `just pgai generate-docs` to update the docs. The `just install-commit-hook` will also install a hook that updates the docs automatically, if any `projects/pgai/pgai/*.python` file changes.
alejandrodnm
force-pushed
the
adn/pydoc-md
branch
from
dcfa205 to
a9728e4
Compare
alejandrodnm
temporarily deployed
to
internal-contributors
GitHub Actions
Inactive
alejandrodnm
force-pushed
the
main
branch
2 times, most recently
from
35e80a5 to
f15011e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.