From a51c92e24883616bd26f831b04a8773b7012b2e8 Mon Sep 17 00:00:00 2001 From: Tomasz Gorochowik Date: Fri, 13 Oct 2023 15:15:53 +0200 Subject: [PATCH] Use the yaml example from README for docs generation --- .github/workflows/docs.yml | 5 ++++- README.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ebaa78b..01b85b6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,10 +24,13 @@ jobs: - name: Install protoplaster with pip run: | pip install . + - name: Install tuttest + run: | + pip install git+https://github.com/antmicro/tuttest - name: Generate docs from yml run: | - protoplaster -t tests/basic.yml --generate-docs + protoplaster -t <(tuttest README.md example) --generate-docs - name: Prepare docs template run: | diff --git a/README.md b/README.md index 83e4fcb..27f4b6c 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ optional arguments: Protoplaster expects a yaml file describing tests as an input. That yaml file should have a specified structure. + ```yaml ---- base: # A group specifier i2c: # A module specifier - bus: 1 # An interface specifier