Impulso/mkdocs.yml at main · niall-stack/Impulso · GitHub

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: impulso
repo_url: https://github.com/thomaspinder/impulso
site_url: https://thomaspinder.github.io/impulso
site_description: Bayesian Vector Autoregression (VAR) in Python.
site_author: Thomas Pinder
edit_uri: edit/main/docs/
repo_name: thomaspinder/impulso
copyright: Maintained by <a href="https://thomaspinder.com">thomaspinder</a>.

nav:
  - Home: index.md
  - Tutorials:
    - tutorials/index.md
    # - tutorials/quickstart.ipynb
    # - tutorials/forecasting.ipynb
    - tutorials/structural-analysis.ipynb
  - How-To Guides:
    - how-to/index.md
    - how-to/data-preparation.md
    - how-to/custom-priors.md
    - how-to/lag-selection.md
    - how-to/sign-restrictions.md
  - Explanation:
    - explanation/index.md
    - explanation/bayesian-var.md
    - explanation/minnesota-prior.md
    - explanation/identification.md
  - Reference:
    - reference/index.md
    - reference/data.md
    - reference/spec.md
    - reference/priors.md
    - reference/samplers.md
    - reference/fitted.md
    - reference/results.md
    - reference/protocols.md
    - reference/identified.md
    - reference/identification.md
    - reference/plotting.md

plugins:
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: true
      remove_tag_config:
          remove_input_tags:
              - hide_code
  - mkdocstrings:
      handlers:
        python:
          paths: ["src"]
          options:
            docstring_style: google
            show_source: false
            heading_level: 2

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - content.code.copy
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/thomaspinder/impulso
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/impulso

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite