Skip to content

Commit

Permalink
doc: add docs on new minimal theme option
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcky committed Jul 3, 2024
1 parent 5184fff commit 915f502
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
install
syntax
options
testing
zreferences
```
Expand Down
22 changes: 22 additions & 0 deletions docs/source/options.md
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`

0 comments on commit 915f502

Please sign in to comment.