Skip to content

Commit

Permalink
Merge pull request #52 from executablebooks/fix-#38
Browse files Browse the repository at this point in the history
DOCS: Improve docs to address theme incompatibility issue
  • Loading branch information
mmcky committed Feb 17, 2022
2 parents 9a74199 + a169c65 commit 92b9614
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/syntax.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Syntax Guide

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

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

0 comments on commit 92b9614

Please sign in to comment.