Skip to content

chore(python): fix autogenerated docs/index.rst to support nested dir #1246

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

Merged
merged 3 commits into from
Oct 19, 2021

Conversation

parthea
Copy link
Contributor

@parthea parthea commented Oct 16, 2021

PR #1114 added docs/index.rst to python templates. PR #1114 didn't generate docs/index.rst properly for python-orchestration-airflow because it only detects versions in the 1st level of the /google/cloud/<API> directory. As a result, no versions are detected. The versions for python-orchestration-airflow are 1 level deeper at /google/cloud/orchestration/airflow. I've also found and fixed a bug where I wasn't checking if the path is a directory.

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

git checkout fix-auto-generated-docs-index-rst-to-work-with-nested 
docker build -f docker/owlbot/python/Dockerfile -t testindexrst .

After cloning python-orchestration-airflow, 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 looks correct and versions are missing

@parthea
Copy link
Contributor Author

parthea commented Oct 18, 2021

@bcoe Please could you take a look?

@parthea parthea merged commit f621fda into master Oct 19, 2021
@parthea parthea deleted the fix-auto-generated-docs-index-rst-to-work-with-nested branch October 19, 2021 23:47
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.

3 participants