disruption-py/mkdocs.yml at dev · MIT-PSFC/disruption-py · 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
---
site_name: DisruptionPy Documentation
theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    scheme: slate
    primary: custom
    accent: custom
extra_css:
  - stylesheets/disruptions.css
  - https://unpkg.com/katex@0/dist/katex.min.css
nav:
  - Overview:
      - Background: index.md
      - Installation: INSTALL.md
      - References: REFERENCES.md
  - Usage:
      - Entry points:
          - Workflow: usage/workflow_reference.md
      - Settings:
          - Settings Classes:
              - Log Settings: usage/settings/log_settings.md
              - Nickname Setting: usage/settings/nickname_setting.md
              - Output Setting: usage/settings/output_setting.md
              - Retrieval Settings: usage/settings/retrieval_settings.md
              - Shotlist Setting: usage/settings/shotlist_setting.md
              - Time Setting: usage/settings/time_setting.md
      - Calculated Parameters:
          - Overview: usage/physics_methods/physics_method_reference.md
          - Physics Methods:
              - Generic Physics Methods: "usage/physics_methods/\
                generic_method_reference.md"
              - C-Mod Physics Methods: "usage/physics_methods/\
                cmod_method_reference.md"
              - DIII-D Physics Methods: "usage/physics_methods/\
                d3d_method_reference.md"
              - EAST Physics Methods: "usage/physics_methods/\
                east_method_reference.md"
              - HBT-EP Physics Methods: "usage/physics_methods/\
                hbtep_method_reference.md"
              - MAST Physics Methods: "usage/physics_methods/\
                mast_method_reference.md"
          - Physics Method Decorators: "usage/physics_methods/\
            decorator_reference.md"
          - Parameter Reference: "usage/physics_methods/\
            disruption_parameters_reference.md"
      - Data I/O:
          - Data Connection (Base): usage/data_connection_reference.md
          - SQL Database: usage/sql_database.md
          - MDSplus Connection: usage/mds_connection_reference.md
  - GitHub: https://github.com/MIT-PSFC/disruption-py
markdown_extensions:
  - attr_list
  - admonition
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: ['']
      dedent_subsections: true
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: ¤
plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            # https://mkdocstrings.github.io/python/usage/configuration/
            docstring_style: numpy
            docstring_section_style: spacy
            show_source: true
            show_signature_annotations: true
            docstring_options:
              ignore_init_summary: true
            inherited_members: false
            merge_init_into_class: false
            separate_signature: true
            # members_order: source
            filters: []

            #  Heading options
            heading_level: 3
            show_root_heading: true
            show_root_full_path: true
            show_root_members_full_path: false
            show_object_full_path: false
extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js