Skip to content

Commit b594599

Browse files
committed
Document default config option
1 parent 69af3fe commit b594599

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/directives/try_examples.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,3 +195,12 @@ Note that these patterns should match the Sphinx docnames of the documentation f
195195
A docname is the relative path from the documentation root to the file of interest,
196196
but without the file extension. For instance, the docname corresponding to `index.rst` at
197197
the root of the Sphinx source directory would be `index`.
198+
199+
A default configuration file can be specified in `conf.py` with the option
200+
`try_examples_default_runtime_config`.
201+
202+
```python
203+
try_examples_default_runtime_config = {
204+
"ignore_patterns": ["^latest/.*", "^stable/reference/generated/example"]
205+
}
206+
```

0 commit comments

Comments
 (0)