causalrl/mkdocs.yml at main · raphaelrrcoelho/causalrl · 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
site_name: causalrl
site_description: "Causal reinforcement learning: the 9-task causal RL taxonomy, made runnable."
site_url: https://raphaelrrcoelho.github.io/causalrl/
repo_url: https://github.com/raphaelrrcoelho/causalrl
repo_name: raphaelrrcoelho/causalrl

# Local notes and process docs live in the
# repo but are not part of the published library documentation.
exclude_docs: |
  superpowers/
  frontier/
  equilibrium_counterfactuals/

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - toc.follow
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

nav:
  - Getting Started: index.md
  - Tour by Task: tour.md
  - Tutorials: tutorials.md
  - Guarantees & Scope: guarantees.md
  - Transportability: transportability.md
  - Causal Discovery: discovery.md
  - Reproducing the Literature: classics.md
  - Reproducible Benchmarks: benchmarks.md
  - Interop (DoWhy / EconML): interop.md
  - Scale (d3rlpy): scale.md
  - Task Guides: guides.md
  - Migrating to 2.0: migration-2.0.md
  - Assumption Glossary: assumptions.md
  - API Reference: api.md
  - Citing: citing.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - toc:
      permalink: true