-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
169 lines (154 loc) · 4.95 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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
#
# Copyright (c) 2023-2024 Agostino De Marco <[email protected]>, University of Naples Federico II
#
# Project information
site_name: Flight Dynamics Book Companion Website
site_url: https://agodemar.github.io/Flight_Dynamics_Book_Companion
site_description: Online companion to the book “Flight Dynamics — Theory and Practice” by ADM and AL
site_author: Agostino De Marco
# Repository information
repo_name: Flight_Dynamics_Book_Companion
repo_url: https://github.com/agodemar/Flight_Dynamics_Book_Companion
edit_uri: blob/master/docs/
# Copyright
copyright: Copyright © 2023 - 2024 Agostino De Marco
plugins:
- mkdocs-jupyter
- search
theme:
name: material
custom_dir: material/overrides
features:
- content.code.copy
- announce.dismiss
# - content.action.edit
# - content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - 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
icon:
annotation: material/arrow-right-circle
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Noto Serif Toto # Roboto
code: Roboto Mono
locale: en
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.superfences
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# see: https://fabacademy.org/2021/labs/bottrop/students/lars-mattern/assignments/01.%20Project%20management/5_mkdocs/
extra_css:
- stylesheets/extra.css
- https://fonts.googleapis.com/css2?family=Noto+Serif+Toto&display=swap
- https://fonts.googleapis.com/css2?family=Caprasimo&display=swap
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# Navigation tree
nav:
- Home: index.md
- Getting Started: Chapter_00/introduction.md
- Aircraft motion in space:
- Theory recap: Chapter_01/00_aircraft_motion_in_space.md
- Attitude in space (1): Chapter_01/example_01_aircraft_orientation.ipynb
- Attitude in space (2): Chapter_01/example_02_aircraft_orientation.ipynb
- Attitude in space (3): Chapter_01/example_03_aircraft_orientation_weight_force.ipynb
- Aerodynamic & engine models:
- Theory recap: Chapter_02/00_aircraft_aerodynamic_engine_models.md
- Chapter 2: Chapter_02/01_pippo.ipynb
- Chapter 2: Chapter_02/02_nicola.ipynb
- Test 0: Chapter_02/test_0.ipynb
- Static stability & control:
- Theory recap: Chapter_03/00_static_stability_control.md
- Dynamics:
- Theory recap: Chapter_04/00_dynamics.md
- Linearized dynamics:
- Theory recap: Chapter_05/00_linearized_dynamics.md
- Miscellanea:
- Chapter_06/00_miscellanea.md
- About: about.md
# --------------- Notes, requirements
#
# --- Make/activate a new conda environment: fdb-companion
#
# conda create -n fdb-companion
# conda activate fdb-companion
#
# --- Install basic stuff
#
# conda install pip
# conda install -c conda-forge jupyterlab
#
# --- Install jupyterlab extension for Matlab
#
# pip install jupyter-matlab-proxy
#
# --- Install MkDocs and MkDocs-Jupyter
#
# pip install mkdocs
#
# --- https://github.com/danielfrg/mkdocs-jupyter
#
# pip install mkdocs-jupyter
#
# --- https://stackoverflow.com/questions/76893872/modulenotfounderror-no-module-named-notebook-base-when-installing-nbextension
# pip install --upgrade notebook==6.4.12
# pip uninstall traitlets
# pip install traitlets==5.9.0
# --------------- Notes, site admin
# 1. mkdocs serve --> to work locally
# 2. commit and push to github the changes in the repository
# 3. mkdocs gh-deploy --> to deploy to github, online version
# This feature is now replaced by the CI workflow - see ./github/workflows/ci.yml -
# that automatically deploys the website to github pages when a push is made to the master branch