PyAOF/mkdocs.yml at main · HaaPut/PyAOF · 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
site_name: PyAOF
site_description: Documentation for PyAOF — Average Outward Flux and Signed Distance Fields
site_author: Tabish Syed
site_url: https://haaput.github.io/pyaof
repo_url: https://github.com/haaput/pyaof

docs_dir: docs
site_dir: site

# ---------------------------------------------------------
# Theme
# ---------------------------------------------------------
theme:
  name: material
  features:
    - header.autohide
    - navigation.footer
    - navigation.tracking
    - content.code.copy
  palette:
    # Light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  logo: assets/aof-spokes.png


# ---------------------------------------------------------
# Plugins (Including API Docs)
# ---------------------------------------------------------
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            inherited_members: true
            show_source: false
  # Required for the 'mike' version provider
  - mike:
      alias_type: symlink


# --------------------------------------------------------
# Structure
# --------------------------------------------------------

nav:
  - Home: index.md
  - API Reference: api.md