Skip to content
This repository was archived by the owner on Aug 25, 2026. It is now read-only.
This repository was archived by the owner on Aug 25, 2026. It is now read-only.

Docs build in google-cloud-build fails with Bullet list ends without a blank line; unexpected unindent #1724

Closed

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/python-cloudbuild/google/cloud/devtools/cloudbuild_v1/types/cloudbuild.py:docstring of google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger:40:Bullet list ends without a blank line; unexpected unindent.

https://github.com/googleapis/googleapis-gen/blob/7e8867efbed7dbfe5ef6ec3c2c92a4bce4280f7a/google/devtools/cloudbuild/v1/devtools-cloudbuild-v1-py/google/cloud/devtools/cloudbuild_v1/types/cloudbuild.py#L2273-L2281

We have

        name (str):
            User-assigned name of the trigger. Must be
            unique within the project. Trigger names must
            meet the following requirements:

            + They must contain only alphanumeric characters
            and dashes. + They can be 1-64 characters long.
            + They must begin and end with an alphanumeric
            character.

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

        name (str):
            User-assigned name of the trigger. Must be
            unique within the project. Trigger names must
            meet the following requirements:

            + They must contain only alphanumeric characters
              and dashes. 
            + They can be 1-64 characters long.
            + They must begin and end with an alphanumeric
              character.

Activity

  1. self-assigned this
    on Aug 8, 2023
  2. parthea commented on Aug 8, 2023

    @parthea
    ContributorAuthor

    I manually fixed the docs build in googleapis/python-cloudbuild@e22d641 to unblock the owlbot PR googleapis/python-cloudbuild#421. I'll start working on a fix in the generator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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