Skip to content

Commit

Permalink
Updated README for multi tool
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidSouther committed Sep 12, 2023
1 parent ad8b207 commit 73600c8
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions .doc_gen/readmes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,15 @@ python .doc_gen/readmes/multi.py --language <language1>:<version> <language2>:<v
For example, to generate S3 and STS READMEs for Python sdk version 3 and Go sdk version 2:

```
python .doc_gen/readmes/writeme.py --languages Python:3 Go:2 --services s3 sts
python .doc_gen/readmes/multi.py --languages Python:3 Go:2 --services s3 sts
```

This creates the README.md files in `python/example_code/s3` and other folders folder.
This creates the README.md files in `python/example_code/s3` and other folders.

To build all READMEs for Rust:

```
$ python .doc_gen/readmes/writeme.py --languages Rust:1
$ python .doc_gen/readmes/multi.py --languages Rust:1
INFO:root:Dry run, no changes will be made.
DEBUG:root:Rendering Rust:1:acm
DEBUG:root:Rendering Rust:1:api-gateway
Expand All @@ -137,7 +137,15 @@ DEBUG:root:Rendering Rust:1:transcribe-medical
DEBUG:root:Rendering Rust:1:translate
```

> Note that at this time, there is no way to specify a `svc_folder` override for the SDKs! This is the main reason this tool is still experimental.
To specify `svc_folder` overrides, add a dict to the language in `config.py` with
the name `service_folder_overrides` and entries with the service name as the key
and complete folder override as the value. See dotnetv3 for an example.

And yes, building all readmes for all languages after changing metadta or templates is now as easy as

```
python .doc_gen/readmes/multi.py
```

### Parameters

Expand Down

0 comments on commit 73600c8

Please sign in to comment.