From ceee0c5c5aa37d299a544f5ad3468c633341cb54 Mon Sep 17 00:00:00 2001 From: Melissa Linkert Date: Fri, 2 Feb 2024 10:26:02 -0600 Subject: [PATCH] Document `svs.remove_thumbnail` option --- sphinx/formats/options.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sphinx/formats/options.rst b/sphinx/formats/options.rst index 75e088a2..dedfc27d 100644 --- a/sphinx/formats/options.rst +++ b/sphinx/formats/options.rst @@ -63,6 +63,12 @@ Reader options - true - If set any missing planes will be replaced by the first plane in the channel. When set to false a blank plane will be returned. + * - :doc:`aperio-svs-tiff` + - ``svs.remove_thumbnail`` + - true + - If set the thumbnail image (if present) will not be available, and in particular + will not be included in the pyramid. When set to false, the thumbnail image will + be available for compatibility with versions <= 7.1.0. Usage ^^^^^