Skip to content

Commit a169c65

Browse files
committed
DOCS: Improve docs to address theme incompatibility issue
1 parent 9a74199 commit a169c65

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/source/syntax.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Syntax Guide
22

3+
```{warning}
4+
This extension currently works best when paired with the following themes:
5+
6+
1. [sphinx_book_theme](https://github.com/executablebooks/sphinx-book-theme)
7+
2. [quantecon_book_theme](https://github.com/quantecon/quantecon-book-theme)
8+
9+
When using other themes (such as `alabaster`) the icons for the `exercise` and `solution` admonitions are missing on the top left.
10+
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)
11+
```
312

413
```{note}
514
This documentation utilized the [Markedly Structured Text (MyST)](https://myst-parser.readthedocs.io/en/latest/index.html) syntax.

0 commit comments

Comments
 (0)