astroemperor/mkdocs.yml at main · ReddTea/astroemperor · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
site_name: emperor
site_description: Exoplanet Mcmc Parallel tEmpering for Rv Orbit Retrieval
site_author: Pablo A. Pena R.

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

nav:
  - Home: index.md
  - User Guide:
      #- Index: user-guide/README.md
      - Installation: user-guide/ug-installation.md
      - Getting Started: user-guide/ug-getting-started.md
      - The Samplers: user-guide/ug-the-samplers.md
      - The Model: user-guide/ug-the-model.md
      - Model Comparison: user-guide/ug-model-comparison.md
      - The Results: user-guide/ug-the-results.md
      - FAQ: user-guide/ug-FAQ.md
  - Tutorials:
      - Peg 51: tutorials/RV_01_51peg_basic.ipynb
      - Peg 51 advanced: tutorials/RV_02_51peg_advanced.ipynb
      - Astrometry: tutorials/AM_01_astrometry.ipynb
      #- Quickstart: tutorials/quickstart/quickstart.md
      #- Fitting a model: tutorials/fitting_model/fitting_model.md
      #- Temperatures & Adaptation: tutorials/temperatures/temperatures.md
      #- Evidence: tutorials/evidence/evidence.md
      #- Parallelization: tutorials/parallelization/parallelization.md
      #- Autocorrelation Analysis: tutorials/autocorrelation-analysis.md
      #- Moves: tutorials/moves.md
  - API Reference: reference/api.md

exclude_docs: |
  tutorials/datalogs/*


theme:
  name: material  # 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
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.arithmatex

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

  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Math-Italic.woff
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Math-Italic.woff2
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Math-Italic.ttf

  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Main-Regular.woff
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Main-Regular.woff2
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Main-Regular.ttf


  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Caligraphic-Regular.woff
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Caligraphic-Regular.woff2
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Caligraphic-Regular.ttf

  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Size2-Regular.woff
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Size2-Regular.woff2
  - https://unpkg.com/katex@0/dist/fonts/KaTeX_Size2-Regular.ttf


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

plugins:
  - search
  - privacy
  - autorefs
  - mkdocstrings
  - mkdocs-jupyter:
      include_source: true
  - redirects:
      redirect_maps:
        tutorials/astrometry.md: https://astroemperor.readthedocs.io/en/latest/tutorials/AM_01_astrometry/


extra:
  analytics:
    provider: google
    property: G-J27XVPQBJD
  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>