aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/configuration.md
blob: 93c926bafe5544263314dd6241bed7289a980bb6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
---
file_format: mystnb
mystnb:
  remove_code_source: true
  execution_mode: 'force'
---
# Configuration

The configuration is stored in yaml file `settings.yaml` at `sec_certs.config` package. Below are the supported options, descriptions and default values.


```{code-cell} python
from sec_certs.config import configuration
from myst_nb import glue
from IPython.display import Markdown

cfg = configuration.config
text = ""
for key in cfg.__dict__:
    text += f"`{key}`\n\n- Description: {cfg.get_desription(key)}\n"
    text += f"- Default value: `{cfg.__getattribute__(key)}`\n\n"
glue("text", Markdown(text))
```
```{glue:md} text
:format: myst
```