fast_turbulence_sim/mkdocs.yml at main · MolinAlexei/fast_turbulence_sim · 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
site_name: Fast Turbulence Sim

site_url: https://molinalexei.github.io/fast_turbulence_sim/

nav:
  - Home: 'index.md'
  - Introduction : 'notebooks/Intro_Observables.ipynb'
  - Using the simulation : 'notebooks/use_sim.ipynb'
  - Create the emissivty table : 'notebooks/Create_emissivity.ipynb'
  - Create the PSF file : 'notebooks/create_psf.ipynb'
  - API Reference :
      - Abundance : 'references/abundance.md'
      - Binning : 'references/binning.md'
      - Cooling : 'references/cooling.md'
      - Cube : 'references/cube.md'
      - Density : 'references/density.md'
      - Emissivity : 'references/emissivity.md'
      - Projection : 'references/projection.md'
      - Simulation : 'references/simulation.md'
      - Structure Function : 'references/structure_function.md'
      - Temperature : 'references/temperature.md'
      - Turbulence : 'references/turbulence.md'


theme:
  name: material
  features:
    - content.tabs.link
    - content.code.copy
    - navigation.indexes
  favicon: logo/logo.png
  logo: logo/logo.png

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

plugins:
  - search
  - mkdocs-jupyter:
      include_requirejs: True
      include_source: True
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.astropy.org/en/stable/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://samreay.github.io/ChainConsumer/objects.inv
            - https://num.pyro.ai/en/stable/objects.inv
            - https://dm-haiku.readthedocs.io/en/latest/objects.inv
            - https://python.arviz.org/en/stable/objects.inv
            - https://astropy-regions.readthedocs.io/en/stable/objects.inv
          options:
            members_order: alphabetical
            docstring_section_style: table
            docstring_style: google
            show_root_heading: true
            heading_level: 2
            show_symbol_type_toc: true

markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde


extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js