-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add docs on new minimal theme option
- Loading branch information
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,7 @@ | |
install | ||
syntax | ||
options | ||
testing | ||
zreferences | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Options | ||
|
||
This package has the option to choose a more **minimal** color scheme. | ||
|
||
The aim is to create admonitions that are clearly different to the core text with | ||
colors that do not over emphasises the admonition. | ||
|
||
To enable the `minimal` color scheme you can use the following. | ||
|
||
## Jupyter Book Project | ||
|
||
Add `proof_minimal_theme = True` to your `_config.yml` | ||
|
||
```yaml | ||
sphinx: | ||
config: | ||
proof_minimal_theme: true | ||
``` | ||
## Sphinx Project | ||
Add `proof_minimal_theme = True` to your `conf.py` |