Conversation
adespawn
left a comment
There was a problem hiding this comment.
I can see the site building correctly, but it seems to contain only API reference - the documentation (./doc/src) is missing
There was a problem hiding this comment.
Will this file need to be manually updated when changing README?
There was a problem hiding this comment.
Yes, but it is placeholder content right now. You'll decide what to document in the frontpage with @annastuchlik (#401 (comment))
This is expected. This PR just adding the automation part, including the API docs. |
| # Setup commands | ||
| .PHONY: setupenv | ||
| setupenv: | ||
| pip install -q poetry |
There was a problem hiding this comment.
🔧 Please use uv, just as @Lorak-mmk did in Rust Driver: scylladb/scylla-rust-driver#1528
There was a problem hiding this comment.
It has broader implications since we have this toolchain installed across 15+ docs projects and we have to maintain it. If it makes sense, we'll do it as a follow-up PR and help all projects migrate to uv at once.
We're now upgrading the theme to support Python 3.14 & Sphinx 9. Might be the right time to make the switch (main benefit is uv is 10–100x faster than poetry for dependency resolution and installs). @annastuchlik, thoughts?
There was a problem hiding this comment.
Imo main benefit is that uv works, and is not a pain to work with, as compared to any other Python package / project manager.
Some projects already migrated:
- Rust Driver: Docs: Migrate to uv scylla-rust-driver#1528
- Python Driver: Set docs workflows in order python-driver#544
- cpp-rs Driver: Migrate docs to UV cpp-rs-driver#410
This option was already enabled |
|
Can this PR be merged now? |
Closes #303
Motivation
Adds a sample docs site to the project & autogenerates docs from jsdoc.
How to test
cd docsmake previewNext steps after merging
Could you please enable the following option?
Thanks!