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.

Sign up for GitHub

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

Jump to bottom

chore(python): rename master_doc to root_doc #1198

Closed
wants to merge 1 commit into from
Closed

chore(python): rename master_doc to root_doc #1198

wants to merge 1 commit into from

Conversation

parthea
Copy link
Contributor

@parthea parthea commented Aug 30, 2021

Rename master_doc to root_doc in python templates. See sphinx docs:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-root_doc

@parthea parthea requested a review from busunkim96 August 30, 2021 14:19
@parthea parthea requested a review from a team as a code owner August 30, 2021 14:19
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Aug 30, 2021
@parthea parthea removed their assignment Aug 30, 2021
@tswast
Copy link
Contributor

tswast commented Aug 30, 2021

Is Version 4 of Sphinx required for this? I recall we used to lock to an older Sphinx. I guess not anymore, seeing as googleapis/python-kms#166 has a passing build?

@dandhlee
Copy link
Contributor

@tswast The old version was pinned because the old sphinx-docfx-yaml required sphinx version lower than 2 due to an incompatibility bug. With the new gcp-sphinx-docfx-yaml I don't think it's strictly required that it's Sphinx version 4 but allows us to use a much newer version.

@parthea
Copy link
Contributor Author

parthea commented Aug 30, 2021

We've pinned to sphinx 4.0.1 in the templated noxfile here. I'll keep an eye out for any failures before merging this change in downstream repos.

@tseaver
Copy link
Contributor

tseaver commented Aug 30, 2021

@parthea for the sake of reducing bot scream, can we please do the replacement of master in templated files in a single PR (i.e., merge this change with PR #1188)?

@parthea parthea added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Aug 31, 2021
@parthea parthea closed this Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tswast tswast tswast approved these changes

@busunkim96 busunkim96 busunkim96 approved these changes

Assignees

@busunkim96 busunkim96

Labels
cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@parthea @tswast @dandhlee @tseaver @busunkim96