1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
import argparse
import logging
import json
from pathlib import Path
import os
CONFIG_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), './package_service_mapping.json')
GENERATED_PACKAGES_LIST_FILE = 'toc_tree.rst'
_LOGGER = logging.getLogger(__name__)
def make_title(title):
"""Create a underlined title with the correct number of =."""
return "\n".join([title, len(title)*"="])
SUBMODULE_TEMPLATE = """{title}
.. automodule:: {namespace}.{submodule}
:members:
:undoc-members:
:show-inheritance:
"""
PACKAGE_TEMPLATE = """{title}
Submodules
----------
.. toctree::
{namespace}.models
{namespace}.operations
Module contents
---------------
.. automodule:: {namespace}
:members:
:undoc-members:
:show-inheritance:
"""
RST_AUTODOC_TOCTREE = """.. toctree::
:maxdepth: 5
:glob:
:caption: Developer Documentation
ref/azure.common
{generated_packages}
ref/azure.servicemanagement
"""
MULTIAPI_VERSION_PACKAGE_TEMPLATE = """{title}
Module contents
---------------
.. automodule:: {namespace}
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
.. toctree::
"""
# Update the code to compute this list automatically
MULTIAPI_VERSION_NAMESPACE = [
"azure.mgmt.storage",
"azure.mgmt.web",
"azure.mgmt.network",
"azure.mgmt.compute",
"azure.mgmt.containerregistry",
"azure.mgmt.containerservice",
"azure.mgmt.dns",
"azure.mgmt.eventhub",
"azure.mgmt.resource.resources",
"azure.mgmt.resource.features",
"azure.mgmt.resource.links",
"azure.mgmt.resource.locks",
"azure.mgmt.resource.policy",
"azure.mgmt.resource.subscriptions",
]
def generate_doc(config_path, output_directory = "./ref/", project_pattern=None):
multiapi_found_apiversion = {}
rst_path_template = os.path.join(output_directory, '{}.rst')
rst_namespace_template = os.path.join(output_directory, '{}.{}.rst')
with Path(config_path).open() as config_fd:
config = json.load(config_fd)
package_list_path = []
namespaces = [n for pack in config.values() for n in pack.get("namespaces", {})]
for namespace in namespaces:
if project_pattern and not any(namespace.startswith(p) for p in project_pattern):
_LOGGER.info("Skip project %s", namespace)
continue
_LOGGER.info("Working on %s", namespace)
rst_path = rst_path_template.format(namespace)
with Path(rst_path).open('w') as rst_file:
rst_file.write(PACKAGE_TEMPLATE.format(
title=make_title(namespace+" package"),
namespace=namespace
))
for module in ["operations", "models"]:
with Path(rst_namespace_template.format(namespace, module)).open('w') as rst_file:
rst_file.write(SUBMODULE_TEMPLATE.format(
title=make_title(namespace+"."+module+" module"),
namespace=namespace,
submodule=module
))
for multiapi_namespace in MULTIAPI_VERSION_NAMESPACE:
length = len(multiapi_namespace.split("."))
if namespace.split(".")[0:length] == multiapi_namespace.split(".")[0:length]:
_LOGGER.info("MultiAPI namespace on %s", multiapi_namespace)
api_package = namespace.split(multiapi_namespace+".")[1]
multiapi_found_apiversion.setdefault(multiapi_namespace, []).append(api_package)
break
else:
package_list_path.append(rst_path)
for multiapi_namespace, apilist in multiapi_found_apiversion.items():
apilist.sort()
apilist.reverse()
rst_path = rst_path_template.format(multiapi_namespace)
with Path(rst_path).open('w') as rst_file:
rst_file.write(MULTIAPI_VERSION_PACKAGE_TEMPLATE.format(
title=make_title(multiapi_namespace+" package"),
namespace=multiapi_namespace
))
for version in apilist:
rst_file.write(" {namespace}.{version}\n".format(
namespace=multiapi_namespace,
version=version))
package_list_path.append(rst_path)
# now handle the packages from data plane that we want to be present properly sorted in the list of packages
for package in config.keys():
if 'manually_generated' in config[package] and config[package]['manually_generated'] == True:
package_list_path.append(rst_path_template.format(package.replace('-','.')))
package_list_path.sort()
with Path(GENERATED_PACKAGES_LIST_FILE).open('w') as generate_file_list_fd:
lines_to_write = "\n".join([" "+package for package in package_list_path])
generate_file_list_fd.write(RST_AUTODOC_TOCTREE.format(generated_packages=lines_to_write))
def main():
parser = argparse.ArgumentParser(
description='Generate documentation file.'
)
parser.add_argument('--project', '-p',
dest='project', action='append',
help='Select a specific project. Do all by default. You can use a substring for several projects.')
parser.add_argument('--config', '-c',
dest='config_path', default=CONFIG_FILE,
help='The JSON configuration format path [default: %(default)s]')
parser.add_argument("-v", "--verbose",
dest="verbose", action="store_true",
help="Verbosity in INFO mode")
parser.add_argument("--debug",
dest="debug", action="store_true",
help="Verbosity in DEBUG mode")
parser.add_argument("--out", "-o",
dest="output_directory",
help="The final resting place for the generated sphinx source files.")
args = parser.parse_args()
main_logger = logging.getLogger()
if args.verbose or args.debug:
logging.basicConfig()
main_logger.setLevel(logging.DEBUG if args.debug else logging.INFO)
generate_doc(args.config_path, args.output_directory, args.project)
if __name__ == "__main__":
main()
|
