light-curve-python/mkdocs.yml at main · light-curve/light-curve-python · 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
site_name: light-curve
site_url: https://light-curve.snad.space/
repo_url: https://github.com/light-curve/light-curve-python
repo_name: light-curve/light-curve-python
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep-orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.action.edit
    - header.autohide

extra:
  generator: false
  version:
    provider: mike
    alias: true

plugins:
  - search
  - mkdocs-jupyter:
      execute: true
      allow_errors: false
      include_source: true
      ignore:
        - "hooks.py"
      execute_ignore:
        - "*/pre-executed/*.ipynb"
  - mkdocstrings:
      custom_templates: docs/templates
      handlers:
        python:
          load_external_modules: true
          options:
            docstring_style: numpy
            docstring_options:
              warn_unknown_params: false
              warn_missing_types: false
              warnings: false
            filters:
              - "^_FeatureEvaluator"
              - "!^_"
            show_source: false
            show_bases: true
            show_signature: false
            show_root_heading: true
            heading_level: 2
            force_inspection: true
            inherited_members: false
            members_order: source
            members: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: .
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - toc:
      toc_depth: 2
      permalink: true
  - pymdownx.arithmatex:
      generic: true

extra_css:
  - stylesheets/extra.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css

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

hooks:
  - docs/hooks.py

watch:
  - CHANGELOG.md
  - light-curve/light_curve

nav:
  - Home: index.md
  - Installation: installation.md
  - Feature Extractors:
      - features/index.md
      - Basics: features/basics.ipynb
      - Multiband: features/multiband.ipynb
      - Batch processing: features/batch_processing.ipynb
      - Periodogram: features/periodogram.ipynb
      - Single-band parametric fits: features/fitting.ipynb
      - Rainbow: features/rainbow.ipynb
      - API:
          - features/api/index.md
          - Base class: features/api/base.md
          - Meta (Extractor, Bins): features/api/meta.md
          - Variability: features/api/variability.md
          - Linear trend: features/api/linear.md
          - Time sampling: features/api/time.md
          - Periodogram: features/api/periodogram.md
          - Non-linear parametric fits: features/api/fitting.md
          - Multiband parametric fit: features/api/rainbow.md
          - Multiband: features/api/multiband.md
          - Detection-based: features/api/detection.md
  - ML Embeddings:
      - embed/index.md
      - Tutorial: embed/tutorial.ipynb
      - Similarity search: embed/pre-executed/similarity_search.ipynb
      - Classification: embed/pre-executed/classification.ipynb
      - onnxruntime tips: embed/onnxruntime.md
      - API: embed/api.md
  - dm–dt maps:
      - dmdt/index.md
      - Tutorial: dmdt/tutorial.ipynb
      - API: dmdt/api.md
  - Changelog: changelog.md
  - Cite & Contact: citing.md
  - Contribute: developer/contributing.md