Skip to content

Commit

Permalink
Make mkdocs more picky about errors
Browse files Browse the repository at this point in the history
  • Loading branch information
tovrstra committed Jun 13, 2024
1 parent eb9f574 commit 5042513
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 2 deletions.
1 change: 0 additions & 1 deletion docs/getting_started/dependencies/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.stepup
story.txt
graph.txt
graph_*.dot
57 changes: 57 additions & 0 deletions docs/getting_started/dependencies/graph.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
root:
version = v1
creates file:./
creates file:plan.py
creates step:./plan.py

file:plan.py
path = plan.py
state = STATIC
created by root:
consumes file:./
supplies step:./plan.py

file:./
path = ./
state = STATIC
created by root:
supplies file:plan.py
supplies file:story.txt
supplies step:./plan.py
supplies step:echo First line. > story.txt; echo Second line. >> story.txt
supplies step:grep First story.txt

step:./plan.py
workdir = ./
command = ./plan.py
state = RUNNING
created by root:
consumes file:./
consumes file:plan.py
creates step:echo First line. > story.txt; echo Second line. >> story.txt
creates step:grep First story.txt

step:echo First line. > story.txt; echo Second line. >> story.txt
workdir = ./
command = echo First line. > story.txt; echo Second line. >> story.txt
state = QUEUED
created by step:./plan.py
consumes file:./
creates file:story.txt
supplies file:story.txt

file:story.txt
path = story.txt
state = PENDING
created by step:echo First line. > story.txt; echo Second line. >> story.txt
consumes file:./
consumes step:echo First line. > story.txt; echo Second line. >> story.txt
supplies step:grep First story.txt

step:grep First story.txt
workdir = ./
command = grep First story.txt
state = PENDING
created by step:./plan.py
consumes file:./
consumes file:story.txt
22 changes: 21 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
site_name: StepUp Core
repo_url: https://github.com/reproducible-reporting/stepup-core
edit_uri: edit/main/docs/
site_description: StepUp Core Documentation
site_author: Toon Verstraelen
copyright: 2024, Toon Verstraelen

watch:
- stepup

#strict: true
validation:
nav:
omitted_files: warn
not_found: warn
absolute_links: warn
links:
not_found: warn
anchors: warn
absolute_links: warn
unrecognized_links: warn

theme:
name: material
Expand Down Expand Up @@ -82,7 +100,9 @@ exclude_docs: |
*/*/public/*.md
plugins:
- search
- search:
lang:
- en
- macros
- mkdocstrings:
default_handler: python
Expand Down

0 comments on commit 5042513

Please sign in to comment.