Skip to content

docs: use uv sync to install docs dependencies in ReadTheDocs build#33

Open
jarsarasty wants to merge 1 commit intomainfrom
readthedocs_build
Open

docs: use uv sync to install docs dependencies in ReadTheDocs build#33
jarsarasty wants to merge 1 commit intomainfrom
readthedocs_build

Conversation

@jarsarasty
Copy link
Copy Markdown
Contributor

@jarsarasty jarsarasty commented Mar 13, 2026

  • ReadTheDocs was using pip to install the docs extra, which failed to resolve sphinx_copybutton and other Sphinx
    dependencies. The fix switches to uv sync --group docs with an explicit Sphinx build command, consistent with how
    dependencies are managed in the rest of the project.
  • Fix typo due to stale API reference in getting_started.rst: get_esdl_with_kpis → build_esdl_with_kpis

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .readthedocs.yaml Outdated
Comment thread .readthedocs.yaml Outdated
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.

2 participants