Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format examples in presigned urls guide #4483

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

jonathan343
Copy link
Contributor

Small PR to format examples in the S3 Presigned URLs dev guide. We should do a follow up to format all examples in our repos.


Testing

Used the following steps to generate docs and verify they generate correctly:

  1. Create a venv using uv venv -p 3.8
  2. Activate the venv uv pip install -r requirements-docs.txt
  3. Install boto3 uv pip install -e .
  4. Change into the docs directory using cd docs
  5. Build the docs using make clean html
    • I modified boto3/docs/__init__.py to only generate docs for one service to speed the build up.
  6. Change into the directory with generated html files cd build/html
  7. Host the html files locally python -m http.server
  8. Verify the http://[::]:8000/guide/s3-presigned-urls.html page renders correctly.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
@jonathan343 jonathan343 merged commit 024ad9a into boto:develop Mar 19, 2025
39 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Mar 19, 2025

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* release-1.37.16:
  Bumping version to 1.37.16
  Add changelog entries from botocore
  Format examples in presigned urls guide (#4483)
hswong3i pushed a commit to alvistack/boto-boto3 that referenced this pull request Mar 20, 2025

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
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.

None yet

2 participants