Skip to content

Docs build in google-cloud-datalabeling fails with Enumerated list ends without a blank line; unexpected unindent. #1723

@parthea

Description

@parthea

See build log here which shows the docs build failure with error message Enumerated 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-datalabeling/google/cloud/datalabeling_v1beta1/types/human_annotation_config.py:docstring of google.cloud.datalabeling_v1beta1.types.human_annotation_config.VideoClassificationConfig:5:Enumerated list ends without a blank line; unexpected unindent.

https://github.com/googleapis/googleapis-gen/blob/7e8867efbed7dbfe5ef6ec3c2c92a4bce4280f7a/google/cloud/datalabeling/v1beta1/datalabeling-v1beta1-py/google/cloud/datalabeling_v1beta1/types/human_annotation_config.py#L245-L251

We have

class VideoClassificationConfig(proto.Message):
    r"""Config for video classification human labeling task.
    Currently two types of video classification are supported:


    1. Assign labels on the entire video.
    2. Split the video into multiple video clips based on camera
    shot, and assign labels on each video clip.

but sphinx expects the text in the final list item to be indented like this

class VideoClassificationConfig(proto.Message):
    r"""Config for video classification human labeling task.
    Currently two types of video classification are supported:


    1. Assign labels on the entire video.
    2. Split the video into multiple video clips based on camera
       shot, and assign labels on each video clip.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions