From 915f502c301ed3138fe01e0778f7047319dbdac1 Mon Sep 17 00:00:00 2001 From: mmcky Date: Wed, 3 Jul 2024 12:43:57 +1000 Subject: [PATCH] doc: add docs on new minimal theme option --- docs/source/index.md | 1 + docs/source/options.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/source/options.md diff --git a/docs/source/index.md b/docs/source/index.md index 0774830..988dccc 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -5,6 +5,7 @@ install syntax +options testing zreferences ``` diff --git a/docs/source/options.md b/docs/source/options.md new file mode 100644 index 0000000..e0bd6a0 --- /dev/null +++ b/docs/source/options.md @@ -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`