Skip to content

[v2] Hide generate_presigned_url from docs and implement nested docs within vendored botocore#10128

Open
aemous wants to merge 2 commits intoaws:v2from
aemous:boto-add-nested-docs-new
Open

[v2] Hide generate_presigned_url from docs and implement nested docs within vendored botocore#10128
aemous wants to merge 2 commits intoaws:v2from
aemous:boto-add-nested-docs-new

Conversation

@aemous
Copy link
Contributor

@aemous aemous commented Mar 13, 2026

Notes:

Description of changes:

  • From Hide generate_presigned_url for all clients but S3 boto/botocore#2554
    • For boto-generated docs, "Our current documentation structure creates one file for each service along with its client methods, exceptions, paginators, and waiters. Having all this content on one page has cased some performance issues on some browsers for large services. This will continue to be an issue as services continue to grow and we need a way to break up service documentation into multiple pages."
  • From Implemented nested doc pages. boto/botocore#2866
    • The generate_presigned_url is generically added to all clients but not all
      services properly support presigned URLs. This adds a filtering mechanism to
      generating client documentation and filters out documenting the method for all
      clients but S3. The method is still present on all clients but will not be
      documented unless we have confirmation that the service supports it.

Description of tests:

  • Successful ran build-and-validate workflow.
  • I checked in my IDE to see if we have any usages of some of the main classes that were modified in the PR. ClientDocumenter, ServiceDocumenter, WaiterDocumenter, etc. No usages found in my IDE in CLIv2

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

…for all clients except s3, and implement nested doc pages within vendored botocore.
@aemous aemous requested a review from a team March 13, 2026 15:45
@aemous aemous added the v2 label Mar 13, 2026
@aemous aemous marked this pull request as ready for review March 13, 2026 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant