FatPy/mkdocs.yml at main · andreachiocca/FatPy · 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
site_name: FatPy
site_description: A Python package for fatigue life evaluation of materials
site_url: https://faberorg.github.io/FatPy/
repo_url: https://github.com/faberorg/FatPy
repo_name: faberorg/FatPy

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - header.autohide
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - toc.follow
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.footnote.tooltips
    - content.tooltips
  icon:
    repo: fontawesome/brands/github
  # logo: images/logo.png
  # favicon: images/logo.png
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search
  - tags
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.betterem
  - pymdownx.blocks.caption
  - tables
  - footnotes
  - md_in_html
  - def_list
  - abbr

  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

  - 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.tasklist:
      custom_checkbox: true

  - pymdownx.arithmatex:
      generic: true

  - toc:
      permalink: true
      toc_depth: 3

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/tablesort.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    provider: google
    property: G-HRZWN2CVF7
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/faberorg/fatpy
      name: FatPy on GitHub
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/faber-cost/
      name: FABER on LinkedIn
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fatpy/
      name: FatPy on PyPI
    - icon: material/web
      link: https://faber-cost.eu/
      name: FABER Website
    - icon: material/email
      link: mailto:jan.vyborny2@gmail.com
      name: Contact Jan Vyborny

nav:
  - Home:
      - Overview: index.md
      - FABER COST: faber_cost.md
      - License: license.md
      - Contact: contact.md
  - API Reference: api/index.md
  - Theory Reference:
      - Overview: theory/index.md
      - Stress Life: theory/stress_life.md
      - Strain Life: theory/strain_life.md
      - Energy Life: theory/energy_life.md
  - Development:
      - Overview: development/index.md
      - Installation: development/install.md
      - Contributing: development/contributing.md
      - Code of Conduct: development/code_of_conduct.md
      - Testing: development/testing.md
      - Code Style: development/code_style.md
      - Documentation: development/documentation.md
      - CI/CD: development/ci_cd.md