From db97488eab966128f6d6bab249cf5d117d13f1e9 Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Wed, 26 Jun 2024 13:44:34 +0100 Subject: [PATCH] Prevent building docs with missing includes (#4239) Fixes: #4221 --- docs/examples/docker.md | 12 ++++++------ docs/examples/kubevirt.md | 14 +++++++------- docs/examples/podman.md | 12 ++++++------ mkdocs.yml | 3 ++- 4 files changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/examples/docker.md b/docs/examples/docker.md index 7df5c774a8..1aee0c2022 100644 --- a/docs/examples/docker.md +++ b/docs/examples/docker.md @@ -11,31 +11,31 @@ installed. ## Config playbook ```yaml title="molecule.yml" -{!docker/molecule.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/molecule.yml!} ``` ```yaml title="requirements.yml" -{!docker/requirements.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/requirements.yml!} ``` ## Create playbook ```yaml title="create.yml" -{!docker/create.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/create.yml!} ``` ```yaml title="tasks/create-fail.yml" -{!docker/tasks/create-fail.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/tasks/create-fail.yml!} ``` ## Converge playbook ```yaml title="converge.yml" -{!docker/converge.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/converge.yml!} ``` ## Destroy playbook ```yaml title="destroy.yml" -{!docker/destroy.yml!} +{!tests/fixtures/integration/test_command/molecule/docker/destroy.yml!} ``` diff --git a/docs/examples/kubevirt.md b/docs/examples/kubevirt.md index c7dc277557..0a12ec3d2b 100644 --- a/docs/examples/kubevirt.md +++ b/docs/examples/kubevirt.md @@ -71,7 +71,7 @@ You will need to substitute the following placeholders: ## Config playbook ```yaml title="molecule.yml" -{!kubevirt/molecule.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/molecule.yml!} ``` Please, replace the following parameters: @@ -80,31 +80,31 @@ Please, replace the following parameters: - ``: Change this to the fully qualified domain name (FQDN) of the Kubernetes node that Ansible will attempt to SSH into via the Service NodePort. ```yaml title="requirements.yml" -{!kubevirt/requirements.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/requirements.yml!} ``` ## Create playbook ```yaml title="create.yml" -{!kubevirt/create.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/create.yml!} ``` ```yaml title="tasks/create_vm.yml" -{!kubevirt/tasks/create_vm.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/tasks/create_vm.yml!} ``` ```yaml title="tasks/create_vm_dictionary.yml" -{!kubevirt/tasks/create_vm_dictionary.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/tasks/create_vm_dictionary.yml!} ``` ## Converge playbook ```yaml title="converge.yml" -{!kubevirt/converge.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/converge.yml!} ``` ## Destroy playbook ```yaml title="destroy.yml" -{!kubevirt/destroy.yml!} +{!tests/fixtures/integration/test_command/molecule/kubevirt/destroy.yml!} ``` diff --git a/docs/examples/podman.md b/docs/examples/podman.md index 63ac62ac98..b0f35ea50e 100644 --- a/docs/examples/podman.md +++ b/docs/examples/podman.md @@ -11,31 +11,31 @@ installed. ## Config playbook ```yaml title="molecule.yml" -{!podman/molecule.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/molecule.yml!} ``` ```yaml title="requirements.yml" -{!podman/requirements.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/requirements.yml!} ``` ## Create playbook ```yaml title="create.yml" -{!podman/create.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/create.yml!} ``` ```yaml title="tasks/create-fail.yml" -{!podman/tasks/create-fail.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/tasks/create-fail.yml!} ``` ## Converge playbook ```yaml title="converge.yml" -{!podman/converge.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/converge.yml!} ``` ## Destroy playbook ```yaml title="destroy.yml" -{!podman/destroy.yml!} +{!tests/fixtures/integration/test_command/molecule/podman/destroy.yml!} ``` diff --git a/mkdocs.yml b/mkdocs.yml index fd76692ffe..4b2d481bc5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -108,7 +108,8 @@ plugins: markdown_extensions: - markdown_include.include: - base_path: tests/fixtures/integration/test_command/molecule/ + base_path: . # CWD (project root) + throwException: true - admonition - def_list - footnotes