Skip to content

Conversation

@jonathan343
Copy link
Contributor

Problem

When code generating a client, the docs/README.md file is currently generated with the following content:

Generating Documentation

Sphinx is used for documentation. You can generate HTML locally with the
following:

$ uv pip install ".[docs]"
$ cd docs
$ make html

However, when running uv pip install ".[docs]", the docs dependencies are not actually installed and the following warning is thrown:

warning: The package `aws-sdk-bedrock-runtime @ file:///Users/gytndd/dev/GitHub/aws-sdk-python/clients/aws-sdk-bedrock-runtime` does not have an extra named `docs`

This is a result of smithy-python#522 which moved the docs group from under [project.optional-dependencies] to [dependency-groups].

Solution

Update the install command to uv pip install --group docs .


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jonathan343 jonathan343 merged commit aeeb9ca into develop Sep 29, 2025
6 checks passed
@jonathan343 jonathan343 deleted the fix-docs-install-cmd branch September 29, 2025 21:26
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