gapic-generator-python
gapic-generator-python copied to clipboard
Docs build in google-cloud-datacatalog and google-cloud-batch fail with `Bullet list ends without a blank line; unexpected unindent.`
See build log here which shows the docs build failure with error message Bullet list ends without a blank line; unexpected unindent.. The issue is that lines in some list items are not indented. The list exists here , but it is not indented properly in the generated output here. For example, see this error below
sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-datacatalog/google/cloud/datacatalog_v1beta1/types/usage.py:docstring of google.cloud.datacatalog_v1beta1.types.usage.UsageStats:8:Bullet list ends without a blank line; unexpected unindent.
https://github.com/googleapis/googleapis-gen/blob/7e8867efbed7dbfe5ef6ec3c2c92a4bce4280f7a/google/cloud/datacatalog/v1beta1/datacatalog-v1beta1-py/google/cloud/datacatalog_v1beta1/types/usage.py#L35-L42
We have
class UsageStats(proto.Message):
r"""Detailed counts on the entry's usage.
Caveats:
- Only BigQuery tables have usage stats
- The usage stats only include BigQuery query jobs
- The usage stats might be underestimated, e.g. wildcard table
references are not yet counted in usage computation
https://cloud.google.com/bigquery/docs/querying-wildcard-tables
but sphinx expects the hyperlink in the final list item to be indented
class UsageStats(proto.Message):
r"""Detailed counts on the entry's usage.
Caveats:
- Only BigQuery tables have usage stats
- The usage stats only include BigQuery query jobs
- The usage stats might be underestimated, e.g. wildcard table
references are not yet counted in usage computation
https://cloud.google.com/bigquery/docs/querying-wildcard-tables