reddemcee/mkdocs.yml at main · ReddTea/reddemcee · 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
site_name: reddemcee
site_description: Adaptative Parallel Tempering MCMC in python.
site_author: Pablo A. Pena R.

repo_url: 'https://github.com/ReddTea/reddemcee/'
site_url: !ENV READTHEDOCS_CANONICAL_URL

nav:
  - Home: index.md
  - User Guide: user-guide/ug-README.md
  - Tutorials:
      - Introduction: tutorials_ntbks/tut-README.md
      #- Quickstart: tutorials/quickstart/quickstart.md
      - Quickstart: tutorials_ntbks/00_quickstart.ipynb
      - Fitting a model: tutorials_ntbks/01_fitting_data.ipynb
      - Temperatures & Adaptation: tutorials_ntbks/02_temperatures.ipynb
      - Evidence: tutorials_ntbks/03_evidence.ipynb
      - Parallelization: tutorials_ntbks/04_parallelization.ipynb
      - Autocorrelation Analysis: tutorials_ntbks/05_autocorrelation_analysis.ipynb
      - Moves: tutorials_ntbks/06_moves.ipynb
  - API Reference: api.md

theme:
  name: material #readthedocs  # material  # readthedocs # mkdocs #

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      accent: indigo
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - header.autohide
    # favicon: fontawesome/solid/chess-king
  logo: img/dark/favicon.svg
  #logo_dark: img/dark/favicon.svg
  #favicon: img/light/favicon.svg
  favicon: img/dark/favicon.svg

  icon:
    repo: fontawesome/brands/github
  # readthedocs
  # color_mode: auto
  # user_color_mode_toggle: true
  # nav_style: primary

markdown_extensions:
  - attr_list
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css

plugins:
  - search
  - privacy
  - autorefs
  - mkdocstrings
  - mkdocs-jupyter:
      include_source: true
      #execute: true

extra:
  analytics:
    provider: google
    property: G-8B8H39TPV5
  consent:
    title: Cookie consent
    actions:
    - accept
    - manage
    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.

copyright: >
  Copyright &copy; 2024 - 2026 Pablo A. Pena R. –
  <a href="#__consent">Change cookie settings</a>