From 96b4e092cfad640413afab96df80d6ec1e2efd86 Mon Sep 17 00:00:00 2001 From: Remi Gacogne Date: Fri, 27 Dec 2024 12:57:19 +0100 Subject: [PATCH] dnsdist: Generate the YAML documentation --- pdns/dnsdistdist/dnsdist-rust-lib/Makefile.am | 1 + .../dnsdist-settings-documentation-generator.py | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/pdns/dnsdistdist/dnsdist-rust-lib/Makefile.am b/pdns/dnsdistdist/dnsdist-rust-lib/Makefile.am index f2d539dd44..19ecd7be16 100644 --- a/pdns/dnsdistdist/dnsdist-rust-lib/Makefile.am +++ b/pdns/dnsdistdist/dnsdist-rust-lib/Makefile.am @@ -18,6 +18,7 @@ rust/src/lib.rs dnsdist-configuration-yaml-items-generated.cc: dnsdist-settings- @if ! $(PYTHON) --version | grep -q "Python 3"; then echo $(PYTHON) should be at least version 3. Please install python 3 and re-run configure; exit 1; fi $(MAKE) -C rust clean (cd ${srcdir} && $(PYTHON) dnsdist-settings-generator.py ../dnsdist-settings-definitions.yml) + $(PYTHON) dnsdist-settings-documentation-generator.py clean-local: rm -f dnsdist-configuration-yaml-items-generated.cc diff --git a/pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-documentation-generator.py b/pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-documentation-generator.py index 78e1d0c8e1..2f12b30768 100644 --- a/pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-documentation-generator.py +++ b/pdns/dnsdistdist/dnsdist-rust-lib/dnsdist-settings-documentation-generator.py @@ -178,6 +178,10 @@ def process_selectors_or_actions(def_file, entry_type): return output def main(): + if not os.path.isdir('../docs'): + print('Skipping settings documentation generation because the ../docs/ folder does not exist') + return + generated_fp = get_temporary_file_for_generated_content('../docs/') output = process_settings() generated_fp.write(output) -- 2.47.2