tess-asteroids/mkdocs.yml at main · jorgemarpa/tess-asteroids · 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
site_name: tess-asteroids

nav:
  - Home: README.md
  - API:
      - movingtpf.md
      - utils.md
  - Tutorials:
    - Tutorial 1 - Basics: tutorials/tutorial1_basics.ipynb
    - Tutorial 2 - Measuring rotation period: tutorials/tutorial2_rotation_periods.ipynb
    - Tutorial 3 - Multiple apertures: tutorials/tutorial3_multiple_apertures.ipynb

repo_url: https://github.com/altuson/tess-asteroids

copyright: Copyright &copy; 2024 Amy Tuson

theme:
  name: "material"

  icon:
    logo: fontawesome/solid/meteor
    repo: fontawesome/brands/github

  features:
    - navigation.footer
    - navigation.tabs
    - navigation.path
    - content.code.copy
    - toc.integrate

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: pink
      accent: indigo

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_root_members_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: "numpy"
            docstring_section_style: list
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
  - mkdocs-jupyter:
      execute: false
      include_source: true
      ignore_h1_titles: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences