aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/install_sources_preserve_path_arg.md8
-rw-r--r--docs/yaml/functions/install_data.yaml9
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/markdown/snippets/install_sources_preserve_path_arg.md b/docs/markdown/snippets/install_sources_preserve_path_arg.md
new file mode 100644
index 0000000..0bc37f2
--- /dev/null
+++ b/docs/markdown/snippets/install_sources_preserve_path_arg.md
@@ -0,0 +1,8 @@
+## Added preserve_path arg to install_data
+
+The [[install_data]] function now has an optional argument `preserve_path`
+that allows installing multi-directory data file structures that live
+alongside source code with a single command.
+
+This is also available in the specialized `py_installation.install_sources`
+method.
diff --git a/docs/yaml/functions/install_data.yaml b/docs/yaml/functions/install_data.yaml
index 3bb9802..191c612 100644
--- a/docs/yaml/functions/install_data.yaml
+++ b/docs/yaml/functions/install_data.yaml
@@ -43,6 +43,15 @@ kwargs:
to install only a subset of the files. By default these files have no install
tag which means they are not being installed when `--tags` argument is specified.
+ preserve_path:
+ type: bool
+ since: 0.64.0
+ default: false
+ description: |
+ Disable stripping child-directories from data files when installing.
+
+ This is equivalent to GNU Automake's `nobase` option.
+
rename:
type: list[str]
since: 0.46.0