@@ -60,7 +60,9 @@ def main(
60
60
False , "--floating-badge" , "--badge" , help = "Turns the version selector menu into a floating badge."
61
61
),
62
62
ignore_conf : bool = typer .Option (
63
- False , "--ignore-conf" , help = "Ignores conf.py configuration file arguments for sphinx-versioned-docs. Warning: conf.py will still be used in sphinx!"
63
+ False ,
64
+ "--ignore-conf" ,
65
+ help = "Ignores conf.py configuration file arguments for sphinx-versioned-docs. Warning: conf.py will still be used in sphinx!" ,
64
66
),
65
67
quite : bool = typer .Option (
66
68
True , help = "Silent `sphinx`. Use `--no-quite` to get build output from `sphinx`."
@@ -120,12 +122,14 @@ def main(
120
122
-------
121
123
:class:`sphinx_versioned.build.VersionedDocs`
122
124
"""
123
- logger_format = "| <level>{level: <8}</level> | - <level>{message}</level>"
124
-
125
+ # Logger init
125
126
log .remove ()
127
+ logger_format = "| <level>{level: <8}</level> | - <level>{message}</level>"
126
128
log .add (sys .stderr , format = logger_format , level = loglevel .upper ())
127
129
130
+ # Parse --branch into either select/exclude variables
128
131
select_branch , exclude_branch = parse_branch_selection (branches )
132
+
129
133
config = {
130
134
"reset_intersphinx_mapping" : reset_intersphinx_mapping ,
131
135
"sphinx_compatibility" : sphinx_compatibility ,
@@ -138,18 +142,18 @@ def main(
138
142
"verbose" : verbose ,
139
143
"quite" : quite ,
140
144
}
141
-
145
+ # Filtered config dict, containing only variables which are `True`
142
146
filtered_config = {x : y for x , y in config .items () if y }
143
147
148
+ # VersionedDocs instance
144
149
DocsBuilder = VersionedDocs (
145
150
chdir = chdir ,
146
151
local_conf = local_conf ,
147
152
output_dir = output_dir ,
148
153
git_root = git_root ,
149
154
ignore_conf = ignore_conf ,
150
- config = filtered_config
155
+ config = filtered_config ,
151
156
)
152
-
153
157
return DocsBuilder .run ()
154
158
155
159
0 commit comments