forked from ACea15/FENIAX
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
154 lines (148 loc) · 6.02 KB
/
mkdocs.yml
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
site_name: FENIAX
site_description: Documentation for aeroelastic library FENIAX.
site_author: Alvaro Cea
docs_dir: docs/documentation
repo_url: https://github.com/ACea15/FENIAX
repo_name: ACea15/FENIAX
edit_uri: "" # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate
strict: False # Don't allow warnings during the build process
theme:
name: material
features:
# - navigation.sections # Sections are included in the navigation on the left.
# - toc.integrate # Table of contents is integrated on the left; does not appear separately on the right.
# - header.autohide # header disappears as you scroll
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.footnote.tooltips
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
# Light mode / dark mode
# We deliberately don't automatically use `media` to check a user's preferences. We default to light mode as
# (a) it looks more professional, and (b) is more obvious about the fact that it offers a (dark mode) toggle.
- scheme: default
primary: white
accent: amber
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to light mode
icon:
repo: fontawesome/brands/github # GitHub logo in top right
# logo: "material/math-integral-box" # logo in top left
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML
markdown_extensions:
- tables
- pymdownx.extra:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- mdx_math
# - pymdownx.arithmatex: # Render LaTeX via MathJax
# generic: true
# - pymdownx.superfences:
# make exceptions to highlighting of code:
# custom_fences:
# - name: mermaid
# class: mermaid
#format: !!python/name:mermaid2.fence_mermaid_custom
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# - class: mermaid
# - format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details # Allowing hidden expandable regions denoted by ???
- pymdownx.snippets: # Include one Markdown file into another
base_path: docs/documentation
- admonition
- toc:
permalink: "¤" # Adds a clickable permalink to each section heading
toc_depth: 4 # Prevents h5, h6 (i.e. methods) from showing up in the TOC.
plugins:
- search # default search plugin; needs manually re-enabling when using any other plugins
- autorefs # Cross-links to headings
- include_exclude_files:
include:
# exclude:
# - "_overrides"
# - "_static/README.md"
- mknotebooks # Jupyter notebooks
#- mkdocs-jupyter:
# ignore_h1_titles: True
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [feniax]
options:
docstring_style: numpy # 'google' 'numpy', 'rst', etc.
filters: ["!^_[^_]"] # Exclude private members
show_root_full_path: true
# setup_commands:
# - import pytkdocs_tweaks
# - pytkdocs_tweaks.main()
selection:
- inherited_members: true # Allow looking up inherited methods
rendering:
- show_root_heading: true # actually display anything at all...
- show_root_full_path: true # display "diffrax.asdf" not just "asdf"
- show_if_no_docstring: true
- show_signature_annotations: true
- show_source: false # don't include source code
- members_order: source # order methods according to their order of definition in the source code, not alphabetical order
- heading_level: 4 # Makes everything top-level be <h4>. Child entries will be <h5> etc., but because of toc_depth, above, (deliberately) won't appear in the TOC.
nav:
- Home: index.md
- Getting started: getting_started.md
- Examples:
- Summary: ./examples.md
# - Structural and aeroelastic response of clamped Aircraft:
# - Free-flying ultra flexible structure
# - CPC_runs: examples/runs.md #../reports/CPC24/runs.md
- Sail Plane static response: examples/SailPlane/sailplane_nb.md
- Wing nonlinear dynamics: examples/wingSP/wingSP_nb.md
- Free flying shell structure: examples/SimoFS/main.md
- Full aircraft (clamped) gust verification: examples/industrialAC/main.md
- Full aircraft trim + dynamic loads: examples/industrialACtrim/main.md
#- Postprocessing
- Theoretical background:
- Intrinsic modal description: theory_intrinsic.md
- Architecture:
- JAX: JAX.md
- UML description: UML.md
- Program inputs: inputs.md
- Code base:
- Inputs: api/inputs.md
- Modes: api/modes.md
- Nonlinear couplings: api/couplings.md