SuchTree/mkdocs.yml at main · ryneches/SuchTree · 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
repo_url: https://github.com/ryneches/suchtree
repo_name: GitHub
site_url: https://suchtree.vort.org
site_description: A Python library for doing fast, thread-safe computations with phylogenetic trees.
site_author: Russell Neches

# Preserve CNAME file for custom domain
docs_dir: docs
site_dir: site

site_name: SuchTree
theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.footer
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - scheme: default
      primary: teal
      accent: purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
  logo: assets/cpu-tree.svg
  favicon: assets/cpu-tree.svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ryneches/suchtree
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/suchtree/

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/config.js
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Introduction: index.md
  - Working Example: examples/SuchTree_examples.md
  - Linked Trees: examples/SuchLinkedTree_examples.md
  - Example Datasets: datasets.md
  - Release Notes: release_notes.md
  - Publication: paper.md
  - Benchmarks: benchmarks.md
  - API Documentation: api_docs.md
  - API Reference: api.md

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

plugins:
  - search
  - social:
      cards: true
      cards_layout_options:
        background_color: "#009688"
        color: "#ffffff"
        font_family: Roboto
        logo: assets/cpu-tree.svg
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            show_signature_annotations: true
            show_source: false
            group_by_category: true
            show_root_heading: false
            members_order: source
            docstring_style: google
            docstring_section_style: table
            merge_init_into_class: true
            show_if_no_docstring: false