Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
parthea opened this issue Aug 8, 2023 · 1 comment · Fixed by #1740
Assignees

Comments

@parthea
Copy link
Contributor

parthea commented Aug 8, 2023

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.
@parthea parthea self-assigned this Aug 8, 2023
parthea added a commit to googleapis/python-cloudbuild that referenced this issue Aug 8, 2023
@parthea
Copy link
Contributor Author

parthea commented Aug 8, 2023

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.

parthea added a commit to googleapis/python-cloudbuild that referenced this issue Aug 8, 2023
* chore: Update gapic-generator-python to v1.11.4

PiperOrigin-RevId: 547897126

Source-Link: googleapis/googleapis@c09c75e

Source-Link: https://github.com/googleapis/googleapis-gen/commit/45e0ec4343517cd0aa66b5ca64232a1802c2f945
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDVlMGVjNDM0MzUxN2NkMGFhNjZiNWNhNjQyMzJhMTgwMmMyZjk0NSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: add git_file_source and git_repo_source to build_trigger

PiperOrigin-RevId: 550012872

Source-Link: googleapis/googleapis@f90d153

Source-Link: https://github.com/googleapis/googleapis-gen/commit/7682e231b6058aa439b4b4f6df236240bf88b3e2
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzY4MmUyMzFiNjA1OGFhNDM5YjRiNGY2ZGYyMzYyNDBiZjg4YjNlMiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: Add automap_substitutions flag to use substitutions as envs in Cloud Build

PiperOrigin-RevId: 551218480

Source-Link: googleapis/googleapis@f823915

Source-Link: https://github.com/googleapis/googleapis-gen/commit/5979eecd8d2b0fc158fe7152a4da43ced2929780
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTk3OWVlY2Q4ZDJiMGZjMTU4ZmU3MTUyYTRkYTQzY2VkMjkyOTc4MCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: add update_mask to UpdateBuildTriggerRequest proto

PiperOrigin-RevId: 552479161

Source-Link: googleapis/googleapis@f8415bd

Source-Link: https://github.com/googleapis/googleapis-gen/commit/4ac7667c7dea38738d9e2176305a804de2258be1
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGFjNzY2N2M3ZGVhMzg3MzhkOWUyMTc2MzA1YTgwNGRlMjI1OGJlMSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* fix docs build. Issue filed upstream here googleapis/gapic-generator-python#1724

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this issue Oct 21, 2023
* chore: Update gapic-generator-python to v1.11.4

PiperOrigin-RevId: 547897126

Source-Link: googleapis/googleapis@c09c75e

Source-Link: googleapis/googleapis-gen@45e0ec4
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDVlMGVjNDM0MzUxN2NkMGFhNjZiNWNhNjQyMzJhMTgwMmMyZjk0NSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: add git_file_source and git_repo_source to build_trigger

PiperOrigin-RevId: 550012872

Source-Link: googleapis/googleapis@f90d153

Source-Link: googleapis/googleapis-gen@7682e23
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzY4MmUyMzFiNjA1OGFhNDM5YjRiNGY2ZGYyMzYyNDBiZjg4YjNlMiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: Add automap_substitutions flag to use substitutions as envs in Cloud Build

PiperOrigin-RevId: 551218480

Source-Link: googleapis/googleapis@f823915

Source-Link: googleapis/googleapis-gen@5979eec
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTk3OWVlY2Q4ZDJiMGZjMTU4ZmU3MTUyYTRkYTQzY2VkMjkyOTc4MCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: add update_mask to UpdateBuildTriggerRequest proto

PiperOrigin-RevId: 552479161

Source-Link: googleapis/googleapis@f8415bd

Source-Link: googleapis/googleapis-gen@4ac7667
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGFjNzY2N2M3ZGVhMzg3MzhkOWUyMTc2MzA1YTgwNGRlMjI1OGJlMSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* fix docs build. Issue filed upstream here googleapis/gapic-generator-python#1724

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant