deeperfly/mkdocs.yml at main · NeLy-EPFL/deeperfly · 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
site_name: deeperfly
site_description: Markerless 3D pose estimation of tethered Drosophila from a multi-camera rig
site_url: https://nely-epfl.github.io/deeperfly/
repo_url: https://github.com/NeLy-EPFL/deeperfly
repo_name: NeLy-EPFL/deeperfly
edit_uri: edit/main/docs/
copyright: GPL-3.0-only

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  features:
    - navigation.sections     # render top-level nav groups as sidebar sections
    - navigation.top          # back-to-top button
    - navigation.tracking     # update the URL with the active anchor
    - content.code.copy       # copy button on code blocks
    - toc.follow
    - search.suggest
  palette:
    # light / dark toggle
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Guides:
      - CLI usage: guides/cli.md
      - Writing configs: guides/configuration.md
      - Library API: guides/library.md
  - Examples:
      - Bundle adjustment: examples/bundle_adjustment.ipynb
      - Pipeline walkthrough: examples/pipeline_walkthrough.ipynb
  - How it works:
      - Pipeline stages: explanation/pipeline.md
      - Keypoint locations: explanation/keypoints.md
      - Conventions & glossary: explanation/conventions.md
  - Reference:
      - Configuration: reference/configuration.md
      - Output format: reference/output-format.md
      - Library API: reference/api.md
  - Contributing: https://github.com/NeLy-EPFL/deeperfly/blob/main/CONTRIBUTING.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.arithmatex:    # render $...$ / $$...$$ LaTeX math via MathJax
      generic: true
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        # Render ```mermaid blocks as diagrams (the data-flow diagrams in
        # "How it works" rely on this).
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  version:
    # Draws the version selector from the `versions.json` mike writes at the site
    # root. Without this the site still deploys per version, but every version
    # looks like the only one and there is no way to get from stable to dev.
    provider: mike
    # `stable` is an ALIAS on whatever main last published, so this default
    # survives a release without an edit here.
    default: stable

extra_javascript:
  # MathJax config + library, loaded for the LaTeX math in "How it works".
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  # Render the example notebooks (symlinked into docs/examples/) straight into
  # the site. execute: false -> use the outputs already stored in the .ipynb, so
  # the build stays fast and needs no torch/jax/data; the Plotly figures stay
  # interactive.
  - mkdocs-jupyter:
      execute: false
      include_source: true
      ignore_h1_titles: false
  - mkdocstrings:
      handlers:
        python:
          # griffe reads the source statically from src/, so building the API
          # reference does not import torch/jax.
          paths: [src]
          options:
            docstring_style: numpy
            docstring_section_style: table
            show_root_heading: true
            show_root_full_path: false
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            filters: ["!^_"]