Skip to content

Docs build in python-video-live-stream failing with Unexpected indentation #1693

@parthea

Description

@parthea

See build log here which shows the docs build failure with error message unexpected indentation. The issue is that sphinx expects a new line before a list. The new line exists in the proto here , but it is not preserved in the generated output here. For example, see this error below

sphinx.errors.SphinxWarning: /home/runner/work/python-video-live-stream/python-video-live-stream/google/cloud/video/live_stream_v1/types/outputs.py:docstring of google.cloud.video.live_stream_v1.types.outputs.PreprocessingConfig.Audio:10:Unexpected indentation.

https://github.com/googleapis/googleapis-gen/blob/52c83f985d3fe2c248378988aee6fda6606f9ef3/google/cloud/video/livestream/v1/video-livestream-v1-py/google/cloud/video/live_stream_v1/types/outputs.py#L484-L490

We have

            bitrate_bps (int):
                Required. The video bitrate in bits per
                second. Minimum value is 10,000.
                - For SD resolution (< 720p), must be <=
                  3,000,000 (3 Mbps).
                - For HD resolution (<= 1080p), must be <=
                  15,000,000 (15 Mbps).

but sphinx expects an additional new line before a list

            bitrate_bps (int):
                Required. The video bitrate in bits per
                second. Minimum value is 10,000.

                - For SD resolution (< 720p), must be <=
                  3,000,000 (3 Mbps).
                - For HD resolution (<= 1080p), must be <=
                  15,000,000 (15 Mbps).

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