Skip to content

Commit

Permalink
reformatting and sorting
Browse files Browse the repository at this point in the history
  • Loading branch information
@ford-at-aws
ford-at-aws committed Sep 25, 2023
1 parent 38f6eb4 commit aa8b09b
Show file tree
Hide file tree
Showing 536 changed files with 32,165 additions and 20,767 deletions.
14 changes: 5 additions & 9 deletions .doc_gen/images/render-blurbs.py
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
import os

import jinja2
import yaml
import os

env = jinja2.Environment(
loader=jinja2.FileSystemLoader(os.path.dirname(__file__))
)
env = jinja2.Environment(loader=jinja2.FileSystemLoader(os.path.dirname(__file__)))

with open('../metadata/sdks.yaml', 'r') as file:
with open("../metadata/sdks.yaml", "r") as file:
metadata = yaml.safe_load(file)
for language in metadata.keys():
metadata[language]
shortname = metadata[language]['property']
shortname = metadata[language]["property"]
template = env.get_template("template.txt")
print(template.render(language=language, shortname=shortname))



222 changes: 111 additions & 111 deletions .doc_gen/readmes/config.py
View file
Original file line number Diff line number Diff line change
@@ -1,160 +1,160 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

readme = 'README.md'
saved_readme = 'README.old.md'
doc_base_url = 'https://docs.aws.amazon.com'
readme = "README.md"
saved_readme = "README.old.md"
doc_base_url = "https://docs.aws.amazon.com"
categories = {
'hello': 'Hello',
'scenarios': 'Scenarios',
"hello": "Hello",
"scenarios": "Scenarios",
}
entities = {
'&AWS;': 'AWS',
'&aws_sec_sdk_use-federation-warning;': '',
'&ASH;': 'Security Hub',
'&DAX;': 'DynamoDB Accelerator',
'&EC2long;': 'Amazon Elastic Compute Cloud',
'&ELBlong;': 'Elastic Load Balancing',
'&GLUDCLong;': 'AWS Glue Data Catalog',
'&GLUDC;': 'Data Catalog',
'&IAM-user;': 'IAM user',
'&IAM-users;': 'IAM users',
'&kms-key;': 'KMS key',
'&kms-keys;': 'KMS keys',
'&SLN;': 'Amazon States Language',
"&AWS;": "AWS",
"&aws_sec_sdk_use-federation-warning;": "",
"&ASH;": "Security Hub",
"&DAX;": "DynamoDB Accelerator",
"&EC2long;": "Amazon Elastic Compute Cloud",
"&ELBlong;": "Elastic Load Balancing",
"&GLUDCLong;": "AWS Glue Data Catalog",
"&GLUDC;": "Data Catalog",
"&IAM-user;": "IAM user",
"&IAM-users;": "IAM users",
"&kms-key;": "KMS key",
"&kms-keys;": "KMS keys",
"&SLN;": "Amazon States Language",
}
language = {
'C++': {
"C++": {
1: {
'base_folder': 'cpp',
'service_folder': 'cpp/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-{{service["name"]}}/html/annotated.html',
"base_folder": "cpp",
"service_folder": 'cpp/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-{{service["name"]}}/html/annotated.html',
}
},
'Go': {
"Go": {
2: {
'base_folder': 'gov2',
'service_folder': 'gov2/{{service["name"]}}',
'sdk_api_ref': 'https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/{{service["name"]}}',
"base_folder": "gov2",
"service_folder": 'gov2/{{service["name"]}}',
"sdk_api_ref": 'https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/{{service["name"]}}',
}
},
'Java': {
"Java": {
2: {
'base_folder': 'javav2',
'service_folder': 'javav2/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{{service["name"]}}/package-summary.html',
"base_folder": "javav2",
"service_folder": 'javav2/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{{service["name"]}}/package-summary.html',
}
},
'JavaScript': {
"JavaScript": {
2: {
'base_folder': 'javascript',
'service_folder': 'javascript/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/{{service["name"] | capitalize}}.html',
"base_folder": "javascript",
"service_folder": 'javascript/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/{{service["name"] | capitalize}}.html',
},
3: {
'base_folder': 'javascriptv3',
'service_folder': 'javascriptv3/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/{{service["name"]}}',
}
"base_folder": "javascriptv3",
"service_folder": 'javascriptv3/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/{{service["name"]}}',
},
},
'Kotlin': {
"Kotlin": {
1: {
'base_folder': 'kotlin',
'service_folder': 'kotlin/services/{{service["name"]}}',
'sdk_api_ref': 'https://sdk.amazonaws.com/kotlin/api/latest/{{service["name"]}}/index.html',
"base_folder": "kotlin",
"service_folder": 'kotlin/services/{{service["name"]}}',
"sdk_api_ref": 'https://sdk.amazonaws.com/kotlin/api/latest/{{service["name"]}}/index.html',
}
},
'.NET': {
".NET": {
3: {
'base_folder': 'dotnetv3',
'service_folder': 'dotnetv3/{{service["name"] | capitalize}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/{{service["name"] | capitalize}}/N{{service["name"] | capitalize}}.html',
'service_folder_overrides': {
'acm': 'dotnetv3/ACM',
'aurora': 'dotnetv3/Aurora',
'auto-scaling': 'dotnetv3/AutoScaling',
'cloudwatch': 'dotnetv3/CloudWatch',
'cloudwatch-logs': 'dotnetv3/CloudWatchLogs',
'cognito': 'dotnetv3/Cognito',
'comprehend': 'dotnetv3/Comprehend',
'dynamodb': 'dotnetv3/dynamodb',
'ec2': 'dotnetv3/EC2',
'ecs': 'dotnetv3/ECS',
'eventbridge': 'dotnetv3/EventBridge',
'glacier': 'dotnetv3/Glacier',
'glue': 'dotnetv3/Glue',
'iam': 'dotnetv3/IAM',
'keyspaces': 'dotnetv3/Keyspaces',
'kinesis': 'dotnetv3/Kinesis',
'kms': 'dotnetv3/KMS',
'lambda': 'dotnetv3/Lambda',
'mediaconvert': 'dotnetv3/MediaConvert',
'organizations': 'dotnetv3/Organizations',
'polly': 'dotnetv3/Polly',
'rds': 'dotnetv3/RDS',
'rekognition': 'dotnetv3/Rekognition',
'route-53': 'dotnetv3/Route53',
's3': 'dotnetv3/S3',
'sagemaker': 'dotnetv3/SageMaker',
'secrets-manager': 'dotnetv3/SecretsManager',
'ses': 'dotnetv3/SES',
'sns': 'dotnetv3/SNS',
'sqs': 'dotnetv3/SQS',
'step-functions': 'dotnetv3/StepFunctions',
'sts': 'dotnetv3/STS',
'support': 'dotnetv3/Support',
'transcribe': 'dotnetv3/Transcribe',
'translate': 'dotnetv3/Translate',
}
"base_folder": "dotnetv3",
"service_folder": 'dotnetv3/{{service["name"] | capitalize}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/{{service["name"] | capitalize}}/N{{service["name"] | capitalize}}.html',
"service_folder_overrides": {
"acm": "dotnetv3/ACM",
"aurora": "dotnetv3/Aurora",
"auto-scaling": "dotnetv3/AutoScaling",
"cloudwatch": "dotnetv3/CloudWatch",
"cloudwatch-logs": "dotnetv3/CloudWatchLogs",
"cognito": "dotnetv3/Cognito",
"comprehend": "dotnetv3/Comprehend",
"dynamodb": "dotnetv3/dynamodb",
"ec2": "dotnetv3/EC2",
"ecs": "dotnetv3/ECS",
"eventbridge": "dotnetv3/EventBridge",
"glacier": "dotnetv3/Glacier",
"glue": "dotnetv3/Glue",
"iam": "dotnetv3/IAM",
"keyspaces": "dotnetv3/Keyspaces",
"kinesis": "dotnetv3/Kinesis",
"kms": "dotnetv3/KMS",
"lambda": "dotnetv3/Lambda",
"mediaconvert": "dotnetv3/MediaConvert",
"organizations": "dotnetv3/Organizations",
"polly": "dotnetv3/Polly",
"rds": "dotnetv3/RDS",
"rekognition": "dotnetv3/Rekognition",
"route-53": "dotnetv3/Route53",
"s3": "dotnetv3/S3",
"sagemaker": "dotnetv3/SageMaker",
"secrets-manager": "dotnetv3/SecretsManager",
"ses": "dotnetv3/SES",
"sns": "dotnetv3/SNS",
"sqs": "dotnetv3/SQS",
"step-functions": "dotnetv3/StepFunctions",
"sts": "dotnetv3/STS",
"support": "dotnetv3/Support",
"transcribe": "dotnetv3/Transcribe",
"translate": "dotnetv3/Translate",
},
}
},
'PHP': {
"PHP": {
3: {
'base_folder': 'php',
'service_folder': 'php/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.{{service["name"] | capitalize}}.html',
"base_folder": "php",
"service_folder": 'php/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.{{service["name"] | capitalize}}.html',
}
},
'Python': {
"Python": {
3: {
'base_folder': 'python',
'service_folder': 'python/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/{{service["name"]}}.html',
"base_folder": "python",
"service_folder": 'python/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/{{service["name"]}}.html',
}
},
'Ruby': {
"Ruby": {
3: {
'base_folder': 'ruby',
'service_folder': 'ruby/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service["name"] | capitalize}}.html',
"base_folder": "ruby",
"service_folder": 'ruby/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/{{service["name"] | capitalize}}.html',
}
},
'Rust': {
"Rust": {
1: {
'base_folder': 'rust_dev_preview',
'service_folder': 'rust_dev_preview/examples/{{service["name"]}}',
'sdk_api_ref': 'https://docs.rs/aws-sdk-{{service["name"]}}/latest/aws_sdk_{{service["name"]}}/',
"base_folder": "rust_dev_preview",
"service_folder": 'rust_dev_preview/examples/{{service["name"]}}',
"sdk_api_ref": 'https://docs.rs/aws-sdk-{{service["name"]}}/latest/aws_sdk_{{service["name"]}}/',
}
},
'SAP ABAP': {
"SAP ABAP": {
1: {
'base_folder': 'sap-abap',
'service_folder': 'sap-abap/services/{{service["name"]}}',
'sdk_api_ref': 'https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/{{service["name"]}}/index.html',
"base_folder": "sap-abap",
"service_folder": 'sap-abap/services/{{service["name"]}}',
"sdk_api_ref": 'https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/{{service["name"]}}/index.html',
}
},
'Swift': {
"Swift": {
1: {
'base_folder': 'swift',
'service_folder': 'swift/example_code/{{service["name"]}}',
'sdk_api_ref': 'https://awslabs.github.io/aws-sdk-swift/reference/0.x/AWS{{service["name"] | capitalize}}/Home',
"base_folder": "swift",
"service_folder": 'swift/example_code/{{service["name"]}}',
"sdk_api_ref": 'https://awslabs.github.io/aws-sdk-swift/reference/0.x/AWS{{service["name"] | capitalize}}/Home',
}
},
'Bash': {
"Bash": {
2: {
'base_folder': 'aws-cli',
'service_folder': 'aws-cli/bash-linux/{{service["name"]}}',
'sdk_api_ref': 'https://awscli.amazonaws.com/v2/documentation/api/latest/reference/{{service["name"]}}/index.html',
"base_folder": "aws-cli",
"service_folder": 'aws-cli/bash-linux/{{service["name"]}}',
"sdk_api_ref": 'https://awscli.amazonaws.com/v2/documentation/api/latest/reference/{{service["name"]}}/index.html',
}
},
}
5 changes: 3 additions & 2 deletions .doc_gen/readmes/multi.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
# SPDX-License-Identifier: Apache-2.0

import argparse
import config
import logging
from scanner import Scanner

import config
from render import Renderer
from scanner import Scanner


def main():
Expand Down
Loading

0 comments on commit aa8b09b

Please sign in to comment.