SLM/mkdocs.yml at main · asemposki/SLM · 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
site_name: Star Log-extended eMulation Documentation (SLM)
site_author: Sudhanva Lalit, Alexandra C. Semposki, and Joshua M. Maldonado
site_description: A Python package for emulating the TOV equations using the Star Log-extended eMulation (SLM) method.
site_url: https://asemposki.github.io/SLM/
theme:
  name: material

  # headers for navigating tabs
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - toc.integrate
    - search.highlight
    - search.share
    - search.suggest
    - content.action.edit

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - footnotes
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - def_list
  - pymdownx.arithmatex: # Added for rendering math (LaTeX) in Markdown and notebooks
      generic: true

extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

# allows for API style docs
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            show_root_heading: true
            show_root_full_path: false
            show_object_full_path: false
            show_source: true
            show_bases: false
            members_order: source
            show_inherited_members: false
            show_docstring_parameters: true
            show_signature_annotations: true
            merge_init_into_class: true
            docstring_options:
              ignore_init_summary: true
            filters: ["!^_"]
            extra:
              render_module_root: true
              render_submodules: true
              show_instance_attributes: false
  - mknotebooks:
      execute_notebooks: true
      notebook_extensions:
        - jupyter_execute
        - jupyter_link
      jupyter_execute:
        execute: true
        timeout: 600
        kernel_name: python3
        allow_errors: true

nav:
  - Home: index.md
  - Documentation:
      - Installation:
          - installation.md
      - API Reference: api.md
  - Tutorials:
      - TOV Code: tutorials/TOV_code.ipynb
      - SLM General: tutorials/SLM_general.ipynb
      - Parametric SLM: tutorials/Parametric_SLM.ipynb
  - Contributing:
      - contributing.md

  - About:
      - Authors: authors.md
      - License: LICENSE

repo_url: https://github.com/asemposki/SLM
repo_name: asemposki/SLM
edit_uri: edit/main/docs
copyright: Copyright &copy; 2025 Sudhanva Lalit, Alexandra C. Semposki, and Joshua M. Maldonado. All rights reserved.