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

fix: fix docs warnings in Sphinx 3.0+ #70

Merged
merged 2 commits into from Apr 9, 2020
Merged

fix: fix docs warnings in Sphinx 3.0+ #70

merged 2 commits into from Apr 9, 2020

Conversation

@plamut
Copy link
Contributor

@plamut plamut commented Apr 9, 2020

Fixes #69.

This PR fixes the docs generation warnings that occur in the latest version of Sphinx, causing the builds to fail (we treat warnings as errors).

To test the PR, generate the docs with and without the changes here. With the changes, the docs build should not fail anymore, while the docs themselves are not changed (apart from the changelog that had some structural issues).

PR checklist:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)
@plamut plamut requested a review from pradn Apr 9, 2020
@plamut plamut changed the title Fix docs warnings in SPhinx 3.0+ Fix docs warnings in Sphinx 3.0+ Apr 9, 2020
pradn
pradn approved these changes Apr 9, 2020
@pradn pradn changed the title Fix docs warnings in Sphinx 3.0+ fix: fix docs warnings in Sphinx 3.0+ Apr 9, 2020
@pradn pradn merged commit 21e761e into googleapis:master Apr 9, 2020
3 checks passed
Loading
@plamut plamut deleted the iss-69 branch Apr 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants