gmat-sweep/mkdocs.yml at main · astro-tools/gmat-sweep · 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
site_name: gmat-sweep
site_description: Run parameter sweeps and Monte Carlo dispersions over GMAT missions in parallel from Python.
site_url: https://astro-tools.github.io/gmat-sweep/
repo_url: https://github.com/astro-tools/gmat-sweep
repo_name: astro-tools/gmat-sweep
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Parameter spec: parameter-spec.md
  - Backends: backends.md
  - Monte Carlo: monte-carlo.md
  - Sensitivity: sensitivity.md
  - Aggregation: aggregation.md
  - Resume: resume.md
  - CLI reference: cli.md
  - Manifest schema: manifest-schema.md
  - Supported versions: supported-versions.md
  - Benchmarks: benchmarks.md
  - Examples:
      - examples/index.md
      - Single-axis SMA scan: examples/01_sma_scan.ipynb
      - Epoch × TOF grid: examples/02_epoch_arrival_grid.ipynb
      - Surviving a kill: examples/03_killed_sweep_recovery.ipynb
      - Monte Carlo dispersion: examples/04_monte_carlo_dispersion.ipynb
      - Latin hypercube vs Monte Carlo: examples/05_latin_hypercube.ipynb
      - Dask cluster recipe: examples/06_dask_cluster_recipe.ipynb
      - Ray autoscaling recipe: examples/07_ray_autoscaling_recipe.ipynb
      - Sobol sensitivity: examples/08_sobol_sensitivity.ipynb
      - Archive bundle: examples/09_archive_bundle.ipynb
      - Extending a Monte Carlo: examples/10_extending_monte_carlo.ipynb
  - Cookbook: cookbook.md
  - Recipes:
      - recipes/index.md
      - Slurm with srun: recipes/slurm.md
      - Kubernetes pod-per-worker: recipes/kubernetes.md
      - Kubernetes Job-per-run: recipes/kubernetes-jobpool.md
      - Ray autoscaling: recipes/ray-autoscaling.md
  - FAQ: faq.md
  - API reference: api.md

plugins:
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            docstring_style: google
            merge_init_into_class: true
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/astro-tools/gmat-sweep