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.

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

Merged
parthea merged 3 commits into from
Oct 19, 2021
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
129de43
chore(python): fix autogenerated docs/index.rst to support nested fol…
parthea Oct 16, 2021
9b78af0
Merge branch 'master' into fix-auto-generated-docs-index-rst-to-work-…
parthea Oct 18, 2021
d965c3f
Merge branch 'master' into fix-auto-generated-docs-index-rst-to-work-…
parthea Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion synthtool/gcp/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ def detect_versions(
pass

# Sort the sub directories alphabetically.
sub_dirs = sorted([p.name for p in Path(path).glob("*v[1-9]*")])
sub_dirs = sorted([p.name for p in Path(path).rglob("*v[1-9]*") if p.is_dir()])

if sub_dirs:
# if `default_version` is not specified, return the sorted directories.
Expand Down
16 changes: 16 additions & 0 deletions tests/test_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,3 +233,19 @@ def test_detect_versions_with_default_version_from_metadata():
json.dump(test_json, metadata)
versions = detect_versions(default_first=True)
assert ["api_v3", "api_v1", "api_v2"] == versions


def test_detect_versions_nested_directory():
temp_dir = Path(tempfile.mkdtemp())
src_dir = temp_dir / "src" / "src2" / "src3"
vs = ("v1", "v2", "v3")
for v in vs:
os.makedirs(src_dir / v)

with util.chdir(temp_dir):
versions = detect_versions(default_version="v1")
assert ["v2", "v3", "v1"] == versions
versions = detect_versions(default_version="v2")
assert ["v1", "v3", "v2"] == versions
versions = detect_versions(default_version="v3")
assert ["v1", "v2", "v3"] == versions