Docs build in google-ai-generativelanguage fails #1776
Description
I had to manually fix a google-cloud-python PR that had a comment looking like this:
Returns:
google.ai.generativelanguage_v1beta3.types.Permission:
Permission resource grants user,
group or the rest of the world access to
the PaLM API resource (e.g. a tuned
model, file).
A role is a collection of permitted
operations that allows users to perform
specific actions on PaLM API resources.
To make them available to users, groups,
or service accounts, you assign roles.
When you assign a role, you grant
permissions that the role contains.
There are three concentric roles. Each
role is a superset of the previous
role's permitted operations:
- reader can use the resource (e.g.
tuned model) for inference
- writer has reader's permissions and
additionally can edit and share
- owner has writer's permissions and
additionally can delete
The issue is that sphinx does not expect a blank space before a list item. Sphinx expects to see
Returns:
google.ai.generativelanguage_v1beta3.types.Permission:
Permission resource grants user,
group or the rest of the world access to
the PaLM API resource (e.g. a tuned
model, file).
A role is a collection of permitted
operations that allows users to perform
specific actions on PaLM API resources.
To make them available to users, groups,
or service accounts, you assign roles.
When you assign a role, you grant
permissions that the role contains.
There are three concentric roles. Each
role is a superset of the previous
role's permitted operations:
- reader can use the resource (e.g.
tuned model) for inference
- writer has reader's permissions and
additionally can edit and share
- owner has writer's permissions and
additionally can delete
We should add this as a test here and also consider proposing an update to AIPs to check if the API protos could follow this convention as well.
See build log here which includes the full stack trace from googleapis/google-cloud-python#11670