-
Notifications
You must be signed in to change notification settings - Fork 84
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
chore(python): include docs/UPGRADING.md in docs/index.rst if it exists #1245
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
parthea
requested review from
bcoe,
chingor13 and
SurferJeffAtGoogle
as code owners
October 15, 2021 13:17
google-cla
bot
added
the
cla: yes
This human has signed the Contributor License Agreement.
label
Oct 15, 2021
This was referenced Oct 16, 2021
busunkim96
reviewed
Oct 18, 2021
parthea
changed the title
chore(python): include docs/upgrading.rst in docs/index.rst if it exists
chore(python): include docs/UPGRADING.md in docs/index.rst if it exists
Oct 18, 2021
This was referenced Oct 19, 2021
busunkim96
approved these changes
Oct 19, 2021
chingor13
approved these changes
Oct 19, 2021
bcoe
approved these changes
Oct 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR #1114 added
docs/index.rst
to python templates. In PR #1114, the migration section was included in the templates. Instead of including the migration section, I'd like to add akwargs
to signal whether a migration guide should be included indocs/index.rst
.I've included the steps I used for testing after cloning synthtool.
After cloning python-access-approval, I completed the following steps
rm -rf owlbot.py
to delete owlbot.py to avoid having to customize owlbot.py to autogenerate docs/index.rstdocker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo testindexrst
docs/index.rst
does not includedocs/upgrading.rst
touch docs/UPGRADING.md
docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo testindexrst
docs/index.rst
includesdocs/upgrading.rst