physics-data-viewer/mkdocs.yml at develop · matt-pharr/physics-data-viewer · 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
site_name: PDV - Physics Data Viewer
site_description: Desktop application for computational and experimental physics analysis
site_url: https://matt-pharr.github.io/physics-data-viewer/
repo_url: https://github.com/matt-pharr/physics-data-viewer
repo_name: matt-pharr/physics-data-viewer
edit_uri: edit/develop/docs/

theme:
  name: material
  logo: assets/pdv-icon.svg
  favicon: assets/pdv-icon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit
  icon:
    repo: fontawesome/brands/github

extra:
  version:
    provider: mike
    default: latest
  analytics:
    provider: google
    property: G-0FGZ9YFWWQ
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for the feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for the feedback! Help us improve by
            <a href="https://github.com/matt-pharr/physics-data-viewer/issues/new?labels=documentation&title=Docs+feedback:+" target="_blank" rel="noopener">opening a documentation issue</a>.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to measure documentation usage so we can see which pages
      are helpful and where users get stuck. Nothing personal is collected.
    actions:
      - accept

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [pdv-python]
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            members_order: source
            heading_level: 2
            filters:
              - "!^_"
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
      enable_git_follow: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path:
        - .
        - docs
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
  - User Guide:
      - Overview: user-guide/index.md
      - Scripts & the Tree: user-guide/scripts-and-tree.md
      - Notes & Projects: user-guide/notes-and-projects.md
  - API Reference:
      - Overview: api-reference/index.md
      - The Tree (pdv_tree): api-reference/tree.md
      - Tree Node Types: api-reference/nodes.md
      - The App Object (pdv): api-reference/app.md
      - Module API: api-reference/module-api.md
      - Exceptions: api-reference/errors.md
      - Julia API (PDVKernel): api-reference/julia.md
  - Module Development: modules/index.md
  - Developer Guide:
      - Architecture: developer/architecture.md
      - Save Pipeline: developer/save-pipeline.md
      - Developer Quick Start: developer/developer-quickstart.md
      - Contributing: developer/contributing.md
      - Development Setup: developer/setup.md
      - Testing: developer/testing.md
  - Changelog: https://github.com/matt-pharr/physics-data-viewer/releases