Skip to content

Conversation

@parthea
Copy link
Contributor

@parthea parthea commented Oct 15, 2021

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 a kwargs to signal whether a migration guide should be included in docs/index.rst.

I've included the steps I used for testing after cloning synthtool.

git checkout include-upgrading-rst-in-index-rst
docker build -f docker/owlbot/python/Dockerfile -t testindexrst .

After cloning python-access-approval, I completed the following steps

  1. Run rm -rf owlbot.py to delete owlbot.py to avoid having to customize owlbot.py to autogenerate docs/index.rst
  2. Run docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo testindexrst
  3. Confirm that docs/index.rst does not include docs/upgrading.rst
  4. Run touch docs/UPGRADING.md
  5. Run docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo testindexrst
  6. Confirm that docs/index.rst includes docs/upgrading.rst

@parthea parthea requested a review from a team October 15, 2021 13:17
@parthea parthea requested a review from a team as a code owner October 15, 2021 13:17
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 15, 2021
@parthea parthea requested a review from busunkim96 October 15, 2021 13:18
@parthea 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
@parthea parthea requested a review from busunkim96 October 18, 2021 17:18
@parthea parthea assigned bcoe and unassigned busunkim96 Oct 19, 2021
@parthea parthea merged commit 949c010 into master Oct 19, 2021
@parthea parthea deleted the include-upgrading-rst-in-index-rst branch October 19, 2021 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants