docs: use uv sync to install docs dependencies in ReadTheDocs build#33
Open
jarsarasty wants to merge 1 commit intomainfrom
Open
docs: use uv sync to install docs dependencies in ReadTheDocs build#33jarsarasty wants to merge 1 commit intomainfrom
jarsarasty wants to merge 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation and Read the Docs build configuration to align docs builds with the project’s uv-based dependency workflow.
Changes:
- Fix Getting Started example to call
KpiManager.build_esdl_with_kpis(...)(matches current API). - Switch ReadTheDocs build to install docs dependencies via
uv sync --group docs. - Run Sphinx via
uv run ...in the RTD build commands.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
doc/getting_started.rst |
Updates an example to use the correct KpiManager method name for building an ESDL object with embedded KPIs. |
.readthedocs.yaml |
Replaces RTD’s python.install/extras flow with explicit uv-based dependency installation and an explicit Sphinx build command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
eddbc0d to
3edd64e
Compare
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
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.
dependencies. The fix switches to
uv sync --group docswith an explicit Sphinx build command, consistent with howdependencies are managed in the rest of the project.