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

Building the docs breaks (unexpected unindent) #69

Closed
plamut opened this issue Apr 9, 2020 · 0 comments · Fixed by #70
Closed

Building the docs breaks (unexpected unindent) #69

plamut opened this issue Apr 9, 2020 · 0 comments · Fixed by #70
Assignees
Labels
api: pubsub Issues related to the googleapis/python-pubsub API. type: docs Improvement to the documentation for an API.

Comments

@plamut
Copy link
Contributor

plamut commented Apr 9, 2020

I noticed that building the docs locally on master fails due to the following error:

sphinx.errors.SphinxWarning: <workspace_dir>/python-pubsub/docs/changelog.md:416:Bullet list ends without a blank line; unexpected unindent.

However, it turns out that the issue does not occur with the older version of Sphinx (< 3.x), thus it appears as a bug in the Sphinx package itself. A workaround is to pin that dependency to an older version, but preferably all new warnings emitted in Sphinx 3.x should be addressed at their sources.

@plamut plamut added the type: docs Improvement to the documentation for an API. label Apr 9, 2020
@plamut plamut self-assigned this Apr 9, 2020
@product-auto-label product-auto-label bot added the api: pubsub Issues related to the googleapis/python-pubsub API. label Apr 9, 2020
@pradn pradn closed this as completed in #70 Apr 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: pubsub Issues related to the googleapis/python-pubsub API. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant