Skip to content

Commit 61d6e7b

Browse files
committed
docs(install): describe dependency refresh
1 parent 8e2dbdd commit 61d6e7b

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

bootstrap.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ def prompt_string(self, prompt, default):
172172
: param default: The default value to use if the user does not provide input.
173173
:return:
174174
"""
175+
if self.options.non_interactive and default is not None:
176+
return default
175177
prompt = prompt.strip()
176178
if prompt.endswith('.'):
177179
prompt = prompt[:-1]
@@ -192,6 +194,8 @@ def prompt_boolean(self, prompt, default = None):
192194
:param default: The default value to return if the user does not provide input.
193195
:return: bool: True if the user answers yes, False otherwise.
194196
"""
197+
if self.options.non_interactive and default is not None:
198+
return default
195199
prompt = prompt.strip()
196200
if prompt.endswith('.'):
197201
prompt = prompt[:-1]

docs/modules/ROOT/pages/install.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ python -c "$(curl -fsSL https://raw.githubusercontent.com/cppalliance/mrdocs/ref
4545
--
4646
====
4747
48-
4948
This method automates the download, configuration, and build steps for MrDocs and all required third-party libraries.
5049
It is especially useful for developers and for users who prefer a streamlined, interactive setup or need to install
5150
MrDocs in custom environments.
@@ -55,7 +54,17 @@ Every option can be defined in the command line directly instead of being prompt
5554
All options can be listed with the `--help` option.
5655
5756
The `--non-interactive` option allows you to run the script without any prompts, using
58-
values specified in the command line and default values for other options. In the default case, the script will download the source code to the current directory and install MrDocs system-wide.
57+
values specified in the command line and default values for other options. This allows you
58+
to only customize the most common options and leave the others to their defaults. This
59+
is handy for developers to refresh dependencies:
60+
61+
[source,bash]
62+
----
63+
python bootstrap.py --non-interactive --mrdocs-build-type=Release --third-party-src-dir=/path/to/dependencies
64+
----
65+
66+
In the default case, the script will download the source code to the current directory
67+
and install MrDocs system-wide.
5968
6069
[tabs]
6170
====

0 commit comments

Comments
 (0)