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
|
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
#
# All configuration values have a default value; values that are commented out
# serve to show the default value.
from locust.argument_parser import get_empty_argument_parser, setup_parser_arguments
import os
import subprocess
import sphinx_rtd_theme
# Run command `locust --help` and store output in cli-help-output.txt which is included in the docs
def save_locust_help_output():
cli_help_output_file = os.path.join(os.path.abspath(os.path.dirname(__file__)), "cli-help-output.txt")
print(f"Running `locust --help` command and storing output in {cli_help_output_file}")
help_output = subprocess.check_output(["locust", "--help"], text=True)
with open(cli_help_output_file, "w") as f:
f.write(help_output)
save_locust_help_output()
# Generate RST table with help/descriptions for all available environment variables
def save_locust_env_variables():
env_options_output_file = os.path.join(os.path.abspath(os.path.dirname(__file__)), "config-options.rst")
print(f"Generating RST table for Locust environment variables and storing in {env_options_output_file}")
parser = get_empty_argument_parser()
setup_parser_arguments(parser)
table_data = []
for action in parser._actions:
if action.env_var and action.help != "==SUPPRESS==":
table_data.append(
(
", ".join([f"``{c}``" for c in action.option_strings]),
f"``{action.env_var}``",
", ".join([f"``{c}``" for c in parser.get_possible_config_keys(action) if not c.startswith("--")]),
action.help,
)
)
colsizes = [max(len(r[i]) for r in table_data) for i in range(len(table_data[0]))]
formatter = " ".join("{:<%d}" % c for c in colsizes)
rows = [formatter.format(*row) for row in table_data]
edge = formatter.format(*["=" * c for c in colsizes])
divider = formatter.format(*["-" * c for c in colsizes])
headline = formatter.format(*["Command line", "Environment", "Config file", "Description"])
output = "\n".join(
[
edge,
headline,
divider,
"\n".join(rows),
edge,
]
)
with open(env_options_output_file, "w") as f:
f.write(output)
save_locust_env_variables()
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
from locust import __version__
# General configuration
# ---------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
"sphinx-prompt",
"sphinx_substitution_extensions",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_search.extension",
]
# autoclass options
# autoclass_content = "both"
autodoc_typehints = "none" # I would have liked to use 'description' but unfortunately it too is very verbose
# Add any paths that contain templates here, relative to this directory.
# templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# General substitutions.
project = "Locust"
# copyright = ''
# Intersphinx config
intersphinx_mapping = {
"requests": ("https://requests.readthedocs.io/en/latest/", None),
}
# The full version, including alpha/beta/rc tags.
release = __version__
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = "%B %d, %Y"
# List of documents that shouldn't be included in the build.
# unused_docs = []
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# Sphinx will recurse into subversion configuration folders and try to read
# any document file within. These should be ignored.
# Note: exclude_dirnames is new in Sphinx 0.5
exclude_dirnames = []
# Options for HTML output
# -----------------------
html_show_sourcelink = False
html_file_suffix = ".html"
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Custom CSS overrides
html_static_path = ["_static"]
html_context = {
"css_files": ["_static/theme-overrides.css", "_static/css/rtd_sphinx_search.min.css"],
}
# HTML theme
# html_theme = "haiku"
# html_theme = "default"
# html_theme_options = {
# "rightsidebar": "true",
# "codebgcolor": "#fafcfa",
# "bodyfont": "Arial",
# }
# The name of the Pygments (syntax highlighting) style to use.
# pygments_style = 'trac'
rst_prolog = f"""
.. |version| replace:: {__version__}
"""
|
