Skip to content

Commit 46f67e3

Browse files
authored
[Doc] update readme.python template (Azure#23743)
* update template * update
1 parent 51c5ade commit 46f67e3

File tree

4 files changed

+28
-86
lines changed

4 files changed

+28
-86
lines changed

doc/dev/mgmt/swagger/multi_api/readme.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,7 @@ This is not used by Autorest itself.
5252

5353
``` yaml $(swagger-to-sdk)
5454
swagger-to-sdk:
55-
- repo: azure-sdk-for-python
56-
after_scripts:
57-
- python ./scripts/multiapi_init_gen.py azure-mgmt-network
55+
- repo: azure-sdk-for-python-track2
5856
- repo: azure-sdk-for-java
5957
- repo: azure-sdk-for-go
6058
- repo: azure-sdk-for-js

doc/dev/mgmt/swagger/multi_api/readme.python.md

Lines changed: 16 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,28 @@
33
These settings apply only when `--python` is specified on the command line.
44

55
``` yaml $(python)
6-
python:
7-
azure-arm: true
8-
license-header: MICROSOFT_MIT_NO_VERSION
9-
payload-flattening-threshold: 2
10-
package-name: azure-mgmt-servicetoreplace
11-
clear-output-folder: true
12-
no-namespace-folders: true
13-
python-base-folder: servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace
14-
python-base-namespace: azure.mgmt.servicetoreplace
6+
azure-arm: true
7+
license-header: MICROSOFT_MIT_NO_VERSION
8+
package-name: azure-mgmt-servicetoreplace
9+
package-version: 1.0.0b1
10+
no-namespace-folders: true
1511
```
1612
1713
### Python multi-api
1814
1915
Generate all API versions currently shipped for this package
2016
2117
```yaml $(python) && $(multiapi)
18+
clear-output-folder: true
2219
batch:
2320
- tag: package-2019-04
2421
- tag: package-2019-02
25-
- tag: package-2018-12
26-
- tag: package-2018-11
27-
- tag: package-2018-10
28-
- tag: package-2018-08
22+
- multiapiscript: true
23+
```
24+
25+
``` yaml $(multiapiscript)
26+
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace/
27+
perform-load: false
2928
```
3029
3130
### Tag: package-2019-04 and python
@@ -34,9 +33,8 @@ These settings apply only when `--tag=package-2019-04 --python` is specified on
3433
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
3534

3635
``` yaml $(tag) == 'package-2019-04' && $(python)
37-
python:
38-
namespace: $(python-base-namespace).v2019_04_01
39-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2019_04_01
36+
namespace: azure.mgmt.servicetoreplace.v2019_04_01
37+
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace/v2019_04_01
4038
```
4139

4240
### Tag: package-2019-02 and python
@@ -45,51 +43,6 @@ These settings apply only when `--tag=package-2019-02 --python` is specified on
4543
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
4644

4745
``` yaml $(tag) == 'package-2019-02' && $(python)
48-
python:
49-
namespace: $(python-base-namespace).v2019_02_01
50-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2019_02_01
51-
```
52-
53-
### Tag: package-2018-12 and python
54-
55-
These settings apply only when `--tag=package-2018-12 --python` is specified on the command line.
56-
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
57-
58-
``` yaml $(tag) == 'package-2018-12' && $(python)
59-
python:
60-
namespace: $(python-base-namespace).v2018_12_01
61-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2018_12_01
62-
```
63-
64-
### Tag: package-2018-11 and python
65-
66-
These settings apply only when `--tag=package-2018-11 --python` is specified on the command line.
67-
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
68-
69-
``` yaml $(tag) == 'package-2018-11' && $(python)
70-
python:
71-
namespace: $(python-base-namespace).v2018_11_01
72-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2018_11_01
73-
```
74-
75-
### Tag: package-2018-10 and python
76-
77-
These settings apply only when `--tag=package-2018-10 --python` is specified on the command line.
78-
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
79-
80-
``` yaml $(tag) == 'package-2018-10' && $(python)
81-
python:
82-
namespace: $(python-base-namespace).v2018_10_01
83-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2018_10_01
84-
```
85-
86-
### Tag: package-2018-08 and python
87-
88-
These settings apply only when `--tag=package-2018-08 --python` is specified on the command line.
89-
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
90-
91-
``` yaml $(tag) == 'package-2018-08' && $(python)
92-
python:
93-
namespace: $(python-base-namespace).v2018_08_01
94-
output-folder: $(python-sdks-folder)/$(python-base-folder)/v2018_08_01
46+
namespace: azure.mgmt.servicetoreplace.v2019_02_01
47+
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace/v2019_02_01
9548
```

doc/dev/mgmt/swagger/single_api/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This is not used by Autorest itself.
5353

5454
``` yaml $(swagger-to-sdk)
5555
swagger-to-sdk:
56-
- repo: azure-sdk-for-python
56+
- repo: azure-sdk-for-python-track2
5757
- repo: azure-sdk-for-java
5858
- repo: azure-sdk-for-go
5959
- repo: azure-sdk-for-net

doc/dev/mgmt/swagger/single_api/readme.python.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,17 @@
22

33
These settings apply only when `--python` is specified on the command line.
44
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
5-
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
65

76
``` yaml $(python)
8-
python-mode: create
9-
python:
10-
azure-arm: true
11-
license-header: MICROSOFT_MIT_NO_VERSION
12-
payload-flattening-threshold: 2
13-
namespace: azure.mgmt.servicetoreplace
14-
package-name: azure-mgmt-servicetoreplace
15-
package-version: 2.0.0
16-
clear-output-folder: true
7+
azure-arm: true
8+
license-header: MICROSOFT_MIT_NO_VERSION
9+
package-name: azure-mgmt-servicetoreplace
10+
namespace: azure.mgmt.servicetoreplace
11+
package-version: 1.0.0b1
12+
clear-output-folder: true
1713
```
18-
``` yaml $(python) && $(python-mode) == 'update'
19-
python:
20-
no-namespace-folders: true
21-
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace
22-
```
23-
``` yaml $(python) && $(python-mode) == 'create'
24-
python:
25-
basic-setup-py: true
26-
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace
14+
15+
``` yaml $(python)
16+
no-namespace-folders: true
17+
output-folder: $(python-sdks-folder)/servicetoreplace/azure-mgmt-servicetoreplace/azure/mgmt/servicetoreplace
2718
```

0 commit comments

Comments
 (0)