Use the yaml example from README for docs generation

antmicro · Oct 13, 2023 · a51c92e · a51c92e
1 parent b9e9cd2
commit a51c92e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git 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
@@ -37,8 +37,8 @@ optional arguments:
 
 Protoplaster expects a yaml file describing tests as an input. That yaml file should have a specified structure.
 
+<!-- name="example" -->
 ```yaml
----
 base:                # A group specifier
   i2c:               # A module specifier
   - bus: 1           # An interface specifier