chore(librarian): create docs/README.rst file during generation #14751
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ohmayr
force-pushed
the
create-index-docs-file
branch
from
514d6dc to
b32d263
Compare
ohmayr
force-pushed
the
create-index-docs-file
branch
from
163f69f to
ff47911
Compare
parthea
changed the title
parthea
approved these changes
Oct 18, 2025
Comment on lines
+526
to
+528
| # Read the content from the source, which will resolve any symlinks. | ||
| with open(source_path, "r") as f: | ||
| content = f.read() |
Contributor
There was a problem hiding this comment.
nit: use the _read_text_file function
google-cloud-python/.generator/cli.py
Lines 61 to 72 in 79a5261
| _write_json_file(output_repo_metadata, metadata_content) | ||
|
|
||
|
|
||
| def _copy_readme_to_docs(output: str, library_id: str): |
Contributor
There was a problem hiding this comment.
Could we create a follow up issue to track adding docs/README.rst to the output of gapic-generator?
This was referenced Oct 20, 2025
parthea
added a commit
that referenced
this pull request
Nov 5, 2025
As of #14751, package level `docs/README.rst` files are included in the generated output and are a copy of the package `README.rst`. We don't need to preserve the existing version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR creates a
docs/index.rstfile for a new library that is configured and generated using librarian.