Skip to content

Commit

Permalink
Run docs code blocks in markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
GDYendell committed Aug 9, 2024
1 parent 3a1b79c commit 04916bc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/how-to/write-a-formatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ pvi supports templates for edl, adl and bob files, which can be referenced from
Inside of the format function, we need to provide a reference to the template file that
can then be used to identify what each widget should look like.

```python3
```python3 notest
template = BobTemplate(str(Path(__file__).parent / "dls.bob"))
```

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ dev = [
"pyright",
"pytest",
"pytest-cov",
"pytest-markdown-docs",
"ruff",
"sphinx-autobuild",
"sphinx-copybutton",
Expand Down Expand Up @@ -70,7 +71,7 @@ strict = ["src/**"]
[tool.pytest.ini_options]
# Run pytest with all our checkers, and don't spam us with massive tracebacks on error
addopts = """
--tb=native -vv --doctest-modules --doctest-glob="*.rst"
--tb=native -vv --doctest-modules --doctest-glob="*.md" --markdown-docs
"""
# https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
filterwarnings = "error"
Expand Down

0 comments on commit 04916bc

Please sign in to comment.