tree-annotated-plot/mkdocs.yml at main · jbloomlab/tree-annotated-plot · 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
site_name: tree-annotated-plot
site_description: >
  Plot a phylogenetic tree alongside an Altair / Vega-Lite chart whose
  categorical axis is reordered to match the tree's tip order.
repo_url: https://github.com/jbloomlab/tree-annotated-plot
edit_uri: ""

# Emit `python-api.html` rather than `python-api/index.html`, so the
# built site works when opened directly via `file://` (no local web
# server required). MkDocs's default "directory URLs" rely on a server
# to resolve `python-api/` → `python-api/index.html`, which fails on
# the filesystem and breaks the inter-page links from the Home page.
use_directory_urls: false

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

nav:
  - Home: index.md
  - Examples: examples.md
  - Command line: cli.md
  - Python API: python-api.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            heading_level: 2

markdown_extensions:
  - admonition
  - attr_list
  - mkdocs-click
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - toc:
      permalink: true