commensurability/mkdocs.yml at main · ilikecubesnstuff/commensurability · 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
site_name: Commensurability
repo_url: https://github.com/ilikecubesnstuff/commensurability/

theme:
  name: 'material'
  language: en
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep-purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep-purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Atkinson Hyperlegible
    code: Ubuntu Mono
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    # - toc.integrate  # NOTE: undecided, can be unwieldy

plugins:
- search:
    lang: en
    # taken from https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- gen-files:
    scripts:
    - docs/gen_ref_pages.py
- literate-nav:
    nav_file: SUMMARY.md
- mkdocstrings

nav:
- Home: index.md
- Motivation: motivation.md
- Installation: installation.md
- Contributing: contributing.md
- Analysis:
  - Quickstart: analysis/quickstart.md
  - Viewer: analysis/viewer.md
- Tessellation:
  - tessellation/index.md
  - Implementation: tessellation/implementation.md
  - Usage:
    - tessellation/usage/index.md
    - Quickstart: tessellation/usage/quickstart.md
    - Tessellation:
      - Milky Way Orbit: tessellation/usage/tessellation/mw_orbit.md
      - Using Pidgey: tessellation/usage/tessellation/pidgey.md
      - Using Multiprocessing: tessellation/usage/tessellation/multiprocessing.md
    - Analysis:
      - Rotating Bar: tessellation/usage/analysis/rotating_bar.md
      - Solar Neighborhood: tessellation/usage/analysis/solar_neighborhood.md
- API Reference: reference/

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      permalink_title: Anchor link to this section for reference

extra_css:
  - stylesheets/extra.css

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