docs(sqlalchemy-spanner): Added docs support to sqlalchemy-spanner#16195
docs(sqlalchemy-spanner): Added docs support to sqlalchemy-spanner#16195gkevinzheng wants to merge 2 commits intomainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enables documentation generation for the sqlalchemy-spanner package by adding a comprehensive README.rst, Sphinx configuration (conf.py), custom CSS, and HTML templates. It also updates the noxfile.py to install necessary dependencies and execute the sphinx-build process. The review feedback identifies a broken link to the samples directory, several typos in the documentation text, and a copy-paste error in the configuration file header.
| The `samples directory <https://github.com/googleapis/google-cloud-python/blob/-/samples/README.md>`__ | ||
| contains multiple examples for how to configure and use common Spanner features. |
There was a problem hiding this comment.
This link to the samples directory appears to be broken. It points to a generic samples README.md at the root of the repository, but it should likely point to the specific samples for sqlalchemy-spanner. Please verify the correct path to the samples and update the link.
| # for SQLAlchemy 1.4 and 2.0: | ||
| spanner+spanner:///projects/project-id/instances/instance-id/databases/database-id | ||
|
|
||
| To pass your custom client object directly to be be used, create engine as following: |
There was a problem hiding this comment.
There's a typo here. 'to be be used' should be 'to be used'.
| To pass your custom client object directly to be be used, create engine as following: | |
| To pass your custom client object directly to be used, create engine as following: |
| | Cloud Spanner dialect includes two dialect-specific arguments for | ||
| ``Table`` constructor, which help to define interleave relations: | ||
| ``spanner_interleave_in`` - a parent table name | ||
| ``spanner_inverleave_on_delete_cascade`` - a flag specifying if |
There was a problem hiding this comment.
There's a typo in spanner_inverleave_on_delete_cascade. It should be spanner_interleave_on_delete_cascade.
| ``spanner_inverleave_on_delete_cascade`` - a flag specifying if | |
| ``spanner_interleave_on_delete_cascade`` - a flag specifying if |
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| ## | ||
| # google-cloud-dataproc documentation build configuration file |
There was a problem hiding this comment.
This comment seems to be a copy-paste error from another package. It should refer to sqlalchemy-spanner instead of google-cloud-dataproc.
| # google-cloud-dataproc documentation build configuration file | |
| # sqlalchemy-spanner documentation build configuration file |
1 participant
Adds docs support so that our docs pipeline does not fail.