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
|
import argparse
import logging
import json
from pathlib import Path
CONFIG_FILE = '../swagger_to_sdk_config.json'
_LOGGER = logging.getLogger(__name__)
SUBMODULE_TEMPLATE = """{namespace}.{submodule} module
===========================================
.. automodule:: {namespace}.{submodule}
:members:
:undoc-members:
:show-inheritance:
"""
PACKAGE_TEMPLATE = """{namespace} package
==========================
Submodules
----------
.. toctree::
{namespace}.models
{namespace}.operations
Module contents
---------------
.. automodule:: {namespace}
:members:
:undoc-members:
:show-inheritance:
"""
def generate_doc(config_path, project_pattern=None):
with Path(config_path).open() as config_fd:
config = json.load(config_fd)
for project, local_conf in config["projects"].items():
if project_pattern and not any(project.startswith(p) for p in project_pattern):
_LOGGER.info("Skip project %s", project)
continue
_LOGGER.info("Working on %s", project)
namespace = local_conf['autorest_options']['Namespace']
with Path('./ref/{}.rst'.format(namespace)).open('w') as rst_file:
rst_file.write(PACKAGE_TEMPLATE.format(
namespace=namespace
))
for module in ["operations", "models"]:
with Path('./ref/{}.{}.rst'.format(namespace, module)).open('w') as rst_file:
rst_file.write(SUBMODULE_TEMPLATE.format(
namespace=namespace,
submodule=module
))
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")
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.project)
if __name__ == "__main__":
main()
|
