Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent building docs with missing includes #4239

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Prevent building docs with missing includes #4239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/examples/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!}
```
14 changes: 7 additions & 7 deletions docs/examples/kubevirt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -80,31 +80,31 @@ Please, replace the following parameters:
- `<Kubernetes Node FQDN>`: 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!}
```
12 changes: 6 additions & 6 deletions docs/examples/podman.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!}
```
3 changes: 2 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading