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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Make the Documentation compatible with Sphinx v 5 #603

Closed
wants to merge 4 commits into from

Conversation

Mariatta
Copy link
Contributor

@Mariatta Mariatta commented Jun 7, 2022

Updated conf.py and specify the language.

Sphinx v5 was just released, and lang = None no longer works.

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • 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)

Fixes #<issue_number_goes_here> 馃

Updated conf.py and specify the language.

Sphinx v5 was just released, and `lang = None` no longer works.
@Mariatta Mariatta requested review from a team as code owners June 7, 2022 16:29
@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. api: bigtable Issues related to the googleapis/python-bigtable API. labels Jun 7, 2022
@product-auto-label product-auto-label bot added size: u Pull request is empty. and removed size: xs Pull request size is extra small. labels Jun 7, 2022
@product-auto-label product-auto-label bot added size: xs Pull request size is extra small. and removed size: u Pull request is empty. labels Jun 7, 2022
@Mariatta
Copy link
Contributor Author

Mariatta commented Jun 7, 2022

Not needed on the main branch since it's pinned to Sphinx 4.

@Mariatta Mariatta closed this Jun 7, 2022
@dandhlee
Copy link
Contributor

dandhlee commented Jun 7, 2022

Hey Mariatta, if there are any reasons to update Sphinx to version 5 I'll update the client library maintainers, but I haven't had the chance to fully explore if this is required yet. Please reach out to me if you'd like to use Sphinx 5 though 馃槂

@Mariatta
Copy link
Contributor Author

Mariatta commented Jun 7, 2022

@dandhlee There's an optimization in Sphinx v.5.0.0b1 that makes building the docs (sphinx-build) faster.
This particular change: sphinx-doc/sphinx#10337

@dandhlee
Copy link
Contributor

dandhlee commented Jun 7, 2022

:O Let me test this out and see if this is true; aiplatform docs take roughly 10 minutes to build, this would be an incredible feat.

@Mariatta Mariatta deleted the Mariatta-patch-1 branch June 7, 2022 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigtable Issues related to the googleapis/python-bigtable API. size: xs Pull request size is extra small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants