OptVL/mkdocs.yml at main · joanibal/OptVL · 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
site_name: OptVL Docs

## Repository
repo_name: optvl
repo_url: https://github.com/joanibal/OptVL
edit_uri: https://github.com/joanibal/OptVL/edit/main/docs

nav:
  - Home: index.md
  - Installation: installation.md
  - Overview: overview.md
  - Analysis:
      - making_a_script.md
      - optvl_api.md
      - v1_to_v2_changes.md
      - optvl_changes_from_avl.md
      - alpha_cl_sweep.md
      - modal_analysis.md
      - parameter_sweeps.md
  - Optimization:
      - optimization_overview.md
      - optimization_setup_scipy.md
      - optimization_setup_om.md
      - planform_optimization.md
  - Visualization:
      - viz_overview.md
      - sectional_data_viz.md
      - making_a_movie.md
  - Development:
      - dev_docs.md
      - common_development_tasks.md
      - building_optvl_locally.md
      - pyavl_changes.md
  # defer to gen-files + literate-nav
  - Code Reference: reference/

watch:
  - optvl

theme:
  name: material

## Plugins
plugins:
  - search:
      # This mess was copied from the example website
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py  #
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
  - literate-nav:
      nav_file: SUMMARY.md

  - include-markdown

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 1-3
  - pymdownx.arithmatex:
      generic: true

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


extra:
  analytics:
    provider: google
    property: G-FRCNFMY9DQ