Skip to content

fix(storage): resolve reST link target mismatch in README and add long_description_content_type - #18210

Open
codyoss wants to merge 1 commit into
googleapis:mainfrom
codyoss:fix-storage-readme-rest-target
Open

fix(storage): resolve reST link target mismatch in README and add long_description_content_type#18210
codyoss wants to merge 1 commit into
googleapis:mainfrom
codyoss:fix-storage-readme-rest-target

Conversation

@codyoss

@codyoss codyoss commented Aug 25, 2026

Copy link
Copy Markdown
Member

Fixes a reST target name mismatch in README.rst and docs/README.rst that caused PyPI upload failures, and explicitly sets long_description_content_type="text/x-rst" in setup.py.

Verified with twine check (PASSED) and unit tests.

Related: #18211

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request corrects a typo in the README and documentation files, changing 'Setup Authentication' to 'Set up Authentication'. It also updates setup.py to include the long_description_content_type parameter set to 'text/x-rst'. No review comments were provided, and there is no additional feedback to offer.

@codyoss
codyoss marked this pull request as ready for review August 25, 2026 02:33
@codyoss
codyoss requested a review from a team as a code owner August 25, 2026 02:33
@codyoss
codyoss enabled auto-merge (squash) August 25, 2026 20:21
@parthea parthea self-assigned this Aug 26, 2026
@parthea

parthea commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

We also need to update this post processing that clobbers the auto-generated README

See the diff below after running librarian code generation

partheniou@partheniou-vm-3:~/google-cloud-python-20260826$ git diff
diff --git a/packages/google-cloud-storage/README.rst b/packages/google-cloud-storage/README.rst
index eeafe4b97ad..7422dfc8840 100644
--- a/packages/google-cloud-storage/README.rst
+++ b/packages/google-cloud-storage/README.rst
@@ -55,7 +55,7 @@ A step-by-step guide may also be found in `Get Started with Client Libraries`_.
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Google Cloud Storage API.:  https://console.cloud.google.com/flows/enableapi?apiid=storage-api.googleapis.com
-.. _Set up Authentication.: https://cloud.google.com/docs/authentication/client-libraries
+.. _Setup Authentication.: https://cloud.google.com/docs/authentication/client-libraries
 
 Installation
 ~~~~~~~~~~~~
diff --git a/packages/google-cloud-storage/docs/README.rst b/packages/google-cloud-storage/docs/README.rst
index eeafe4b97ad..7422dfc8840 100644
--- a/packages/google-cloud-storage/docs/README.rst
+++ b/packages/google-cloud-storage/docs/README.rst
@@ -55,7 +55,7 @@ A step-by-step guide may also be found in `Get Started with Client Libraries`_.
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Google Cloud Storage API.:  https://console.cloud.google.com/flows/enableapi?apiid=storage-api.googleapis.com
-.. _Set up Authentication.: https://cloud.google.com/docs/authentication/client-libraries
+.. _Setup Authentication.: https://cloud.google.com/docs/authentication/client-libraries
 
 Installation
 ~~~~~~~~~~~~
diff --git a/packages/google-cloud-storage/setup.py b/packages/google-cloud-storage/setup.py
index aaf15566415..036babf4a93 100644
--- a/packages/google-cloud-storage/setup.py
+++ b/packages/google-cloud-storage/setup.py
@@ -117,7 +117,6 @@ setuptools.setup(
     version=version,
     description=description,
     long_description=readme,
-    long_description_content_type="text/x-rst",
     author="Google LLC",
     author_email="googleapis-packages@google.com",
     license="Apache-2.0",

@parthea parthea assigned codyoss and unassigned parthea Aug 26, 2026
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