rocketstruct/mkdocs.yml at main · felipebogaertsm/rocketstruct · 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
site_name: rocketstruct
site_url: https://felipebogaertsm.github.io/rocketstruct/
site_description: Structural analysis for pressure vessels, plates, and bolted joints
site_author: Felipe Bogaerts de Mattos

repo_url: https://github.com/felipebogaertsm/rocketstruct
repo_name: felipebogaertsm/rocketstruct

theme:
  name: material
  palette:
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_root_heading: true
            docstring_style: google

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - How-to:
      - Cylindrical vessel wall: how-to/cylindrical-vessel-wall.md
      - Bolted joint: how-to/bolted-joint.md
      - Bulkhead wall: how-to/bulkhead-wall.md
  - Theory:
      - 1. Cylindrical Vessel: theory/cylindrical_vessel.md
      - 2. Flat Plate: theory/flat_plate.md
      - 3. Bolted Joint: theory/bolted_joint.md
      - 4. Margin of Safety: theory/margin_of_safety.md
  - Modules:
      - core:
          - Overview: api/core.md
          - cylindrical_vessel: api/core/cylindrical_vessel.md
          - flat_plate: api/core/flat_plate.md
          - bolted_joint: api/core/bolted_joint.md
      - components:
          - Overview: api/components.md
          - cylindrical_vessel: api/components/cylindrical_vessel.md
          - flat_plate: api/components/flat_plate.md
          - bolted_joint: api/components/bolted_joint.md
      - materials: api/materials.md

extra_css:
  - stylesheets/extra.css

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

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true