Skip to content

Commit 4097d37

Browse files
authored
Merge pull request #54 from ouseful-PR/patch-1
Update syntax.md: use with Jupyter Book
2 parents 92b9614 + 3408ff8 commit 4097d37

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/source/syntax.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ When using other themes (such as `alabaster`) the icons for the `exercise` and `
1010
We would like to make this more theme agnostic and status can be found in [this issue](https://github.com/executablebooks/sphinx-exercise/issues/51)
1111
```
1212

13+
`````{note}
14+
To use this extension in a Jupyter Book project, add `sphinx_exercise` as an extension in the `_config.yml` file.
15+
16+
```{code-block} python
17+
sphinx:
18+
extra_extensions:
19+
- sphinx_exercise
20+
```
21+
22+
`````
23+
1324
```{note}
1425
This documentation utilized the [Markedly Structured Text (MyST)](https://myst-parser.readthedocs.io/en/latest/index.html) syntax.
1526
```

0 commit comments

Comments
 (0)