From 4c7546cb314ffe5da31d5f3b0b45a5a8ee3ea1ea Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 14 Aug 2023 08:12:16 -0600 Subject: [PATCH] sphinx: skip options include dir Tell sphinx not to process the "options" dir, those files are not to be published. Context: websearching for podman volume info, I stumbled upon: https://docs.podman.io/en/latest/markdown/options/volume.html ...and panicked because I saw '<>', the options include-file syntax that should never be seen by users. I thought the filter script was broken. Signed-off-by: Ed Santiago --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 345e289e1c..4f9bd09eda 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -49,7 +49,7 @@ templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] +exclude_patterns = ["markdown/options"] master_doc = "index"