DaSPi/mkdocs.yml at main · j4ggr/DaSPi · 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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
site_name: DaSPi
site_description: Process Analytics & Six Sigma in Python — integrated workflows for capability analysis, root cause analysis, and statistical process control
site_author: j4ggr
site_url: https://j4ggr.github.io/DaSPi

theme:
  name: material
  custom_dir: overrides
  logo: img/logo_w.ico
  favicon: img/logo.ico
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: teal
      accent: amber

  features:
    - search.suggest
    - search.highlight
    - search.share
    - content.tabs.link
    - content.tooltips
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.indexes
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow

repo_name: j4ggr/DaSPi
repo_url: https://github.com/j4ggr/DaSPi

plugins:
  search: null
  mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: numpy
          docstring_section_style: spacy
          heading_level: 2
          merge_init_into_class: true
          show_bases: true
          show_source: false
          show_root_heading: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_docstring_functions: true
          inherited_members: false
          members_order: source
          group_by_category: true
          show_if_no_docstring: false
          filters:
            - "!^_"
            - "^__init__"

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true

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

extra_css:
  - css/custom-colors.css

nav:
  - Home:
    - DaSPi: index.md
    - Changelog: CHANGELOG.md
  - User Guide:
    - guides/index.md
    - Three Flagship Workflows:
      - guides/workflow-capability.md
      - guides/workflow-root-cause.md
      - guides/workflow-spc.md
    - guides/installing.md
    - guides/configuration.md
    - guides/anova.md
    - guides/doe.md
    - guides/plotting.md
    - guides/gage_analysis.md
    - guides/hypothesis-testing.md
    - 3S Methodology:
      - guides/3s-methodology.md
      # - guides/3s-specify.md
      # - guides/3s-scrutinize.md
      # - guides/3s-stabilize.md
  - API:
    - Anova:
      - ANOVA: anova/index.md
      - anova/linear-model.md
      - anova/gage-study-model.md
      - anova/gage-rnr-model.md
    - DOE:
      - Design of Experiments: doe/index.md
      - doe/factor.md
      - doe/design-builders.md
      - doe/full-factorial.md
      - doe/fractional-factorial.md
    - Plotlib:
      - Plotting Library: plotlib/index.md
      - Precast Charts:
        - Precast Module: plotlib/precast/index.md
        - plotlib/precast/residual-charts.md
        - plotlib/precast/parameter-relevance-charts.md
        - plotlib/precast/pair-comparison-charts.md
        - plotlib/precast/pairwise-matrix-charts.md
        - plotlib/precast/bivariate-univariate-charts.md
        - plotlib/precast/process-capability-analysis-charts.md
        - plotlib/precast/gage-study-charts.md
        - plotlib/precast/gage-rnr-charts.md
      - Chart:
        - Chart Module: plotlib/chart/index.md
        - plotlib/chart/chart.md
        - plotlib/chart/single-chart.md
        - plotlib/chart/multivariate-chart.md
        - plotlib/chart/joint-chart.md
      - Plotter:
        - Plotter Module: plotlib/plotter/index.md
        - plotlib/plotter/plotter.md
        - plotlib/plotter/scatter.md
        - plotlib/plotter/line.md
        - plotlib/plotter/stem.md
        - plotlib/plotter/linear-regression-line.md
        - plotlib/plotter/loess-line.md
        - plotlib/plotter/probability.md
        - plotlib/plotter/parallel-coordinate.md
        - plotlib/plotter/transform-plotter.md
        - plotlib/plotter/center-location.md
        - plotlib/plotter/bar.md
        - plotlib/plotter/pareto.md
        - plotlib/plotter/jitter.md
        - plotlib/plotter/beeswarm.md
        - plotlib/plotter/categorical-observation.md
        - plotlib/plotter/quantile-boxes.md
        - plotlib/plotter/gaussian-kde.md
        - plotlib/plotter/gaussian-kde-contour.md
        - plotlib/plotter/gaussian-kde-contour-univariate.md
        - plotlib/plotter/violin.md
        - plotlib/plotter/errorbar.md
        - plotlib/plotter/standard-error-mean.md
        - plotlib/plotter/spread-width.md
        - plotlib/plotter/confidence-interval.md
        - plotlib/plotter/mean-test.md
        - plotlib/plotter/variation-test.md
        - plotlib/plotter/proportion-test.md
        - plotlib/plotter/capability-confidence-interval.md
        - plotlib/plotter/subplot.md
        - plotlib/plotter/stripe.md
        - plotlib/plotter/bland-altman.md
      - Facets:
        - Facets Module: plotlib/facets/index.md
        - plotlib/facets/axes-facets.md
        - plotlib/facets/label-facets.md
        - plotlib/facets/stripes-facets.md
    - Statistics:
      - Statistics Library: statistics/index.md
      - Hypothesis:
        - statistics/hypothesis/index.md
      - Estimation:
        - statistics/estimation/index.md
        - statistics/estimation/distribution-estimator.md
        - statistics/estimation/location-dispersion-estimator.md
        - statistics/estimation/process-estimator.md
        - statistics/estimation/gage-estimator.md
        - statistics/estimation/loess.md
      - Confidence:
        - statistics/confidence/index.md
      - Monte-Carlo Library: statistics/montecarlo/index.md