causalprog/mkdocs.yml at main · UCL/causalprog · 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
site_name: "causalprog"
site_description: "Documentation website for causalprog"
site_author: "Collaborations team, UCL Centre for Advanced Research Computing"
copyright: >
  Copyright © 2025 University College London -
  <a href="#__consent">Change cookie settings</a>
repo_url: "https://github.com/UCL/causalprog/"
repo_name: "UCL/causalprog"
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: "material"
  features:
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github

nav:
  - Overview: index.md
  - Theory:
      - Simple working example: theory/simple-working-example.md
      - Terminology: theory/glossary.md
  - Developers:
      - Testing suite: developers/tests.md
  - API reference: api.md
  - License: LICENSE.md

markdown_extensions:
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
            - "https://docs.python.org/3/objects.inv"
          options:
            docstring_style: google
            show_submodules: true
          paths: [src]
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - reject
      - manage
      - accept
  social:
    - icon: fontawesome/brands/github
      link: "https://github.com/UCL"

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js