Skip to content

update mgmt docs build to not rely on hardcoded mappings #34482

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
kristapratico merged 4 commits into from
Mar 6, 2024
Merged

update mgmt docs build to not rely on hardcoded mappings #34482

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b99f14
hardcoding everything wip, should able to compute automatically
kristapratico Feb 12, 2024
5b87b8b
update the code to not use hardcoded package_service_mapping
kristapratico Feb 19, 2024
62d053a
make sure we preserve ordering of latest --> oldest
kristapratico Feb 19, 2024
9324e6c
update copyright year
kristapratico Feb 19, 2024
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
Prev Previous commit
Next Next commit
make sure we preserve ordering of latest --> oldest
  • Loading branch information
@kristapratico
kristapratico committed Feb 19, 2024
commit 62d053a10e6d4f8dae9c3dc282fbc40c11ec3186
20 changes: 10 additions & 10 deletions doc/sphinx/generate_doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import os
import glob

import typing
from typing import Dict, List

GENERATED_PACKAGES_LIST_FILE = "toc_tree.rst"
Expand Down Expand Up @@ -84,7 +83,6 @@ def is_subnamespace(version: str) -> bool:

def get_package_namespaces(package_root: str) -> List[str]:
namespace_folders = os.path.basename(package_root).split("-")
package_name = "-".join(namespace_folders)
namespace = ".".join(namespace_folders)

# add top namespace
Expand All @@ -96,20 +94,22 @@ def get_package_namespaces(package_root: str) -> List[str]:
# check for subnamespaces like azure.mgmt.resource.locks
if not valid_versions:
subnamespaces = glob.glob(f"{api_directory}/*/")
for snp in subnamespaces:
versions = get_valid_versions(snp)
for snp_path in subnamespaces:
versions = get_valid_versions(snp_path)
valid_versions.extend(versions)

for version_path in valid_versions:
version = os.path.relpath(version_path, start=api_directory)
if is_subnamespace(version):
subnamespace, api_version = version.split("/")
full_namespace = ".".join([namespace, subnamespace, api_version])
namespaces.setdefault(namespace, []).append(".".join([namespace, subnamespace]))
namespaces.setdefault(f"{namespace}.{subnamespace}", []).append(full_namespace)
subnamespace_name, api_version = version.split("/")
full_namespace = ".".join([namespace, subnamespace_name, api_version])
subnamespace = ".".join([namespace, subnamespace_name])
if subnamespace not in namespaces[namespace]:
namespaces[namespace].append(subnamespace)
namespaces.setdefault(subnamespace, []).append(full_namespace)
else:
full_namespace = ".".join([namespace, version])
namespaces.setdefault(namespace, []).append(full_namespace)
namespaces[namespace].append(full_namespace)

return namespaces

Expand Down Expand Up @@ -137,7 +137,7 @@ def write_multiapi_rst(namespace: str, versions: List[str], rst_path_template: s
title=make_title(namespace + " package"), namespace=namespace
)
)
for version in set(versions):
for version in versions:
rst_file.write(" {version}\n".format(version=version))
package_list_path.append(rst_path)

Expand Down