File: mkdocs.yml

package info (click to toggle)
antimeridian 0.4.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,964 kB
  • sloc: python: 1,172; sh: 8; makefile: 4
file content (71 lines) | stat: -rw-r--r-- 1,487 bytes parent folder | download | duplicates (2)
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
site_name: antimeridian
site_url: https://gadomski.github.io/antimeridian/
site_author: Pete Gadomski
repo_name: gadomski/antimeridian
repo_url: https://github.com/gadomski/antimeridian
edit_uri: edit/main/docs/

extra:
  social:
    - icon: "fontawesome/brands/github"
      link: "https://github.com/gadomski"
  version:
    provider: mike

theme:
  name: material
  logo: img/complex-split.png
  favicon: img/complex-split.png
  icon:
    repo: fontawesome/brands/github
  palette:
    primary: deep orange
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - search.share
    - search.suggest

nav:
  - Home: index.md
  - the-algorithm.md
  - examples.ipynb
  - failure-modes.ipynb
  - comparison.ipynb
  - api.md
  - cli.md

exclude_docs: paper.md

watch:
  - docs
  - src

plugins:
  - search
  - social
  - mike
  - mkdocs-jupyter
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: list
            separate_signature: true
            show_signature_annotations: true
            show_symbol_type_toc: true
            signature_crossrefs: true
          import:
            - https://shapely.readthedocs.io/en/stable/objects.inv

markdown_extensions:
  - pymdownx.snippets
  - pymdownx.superfences
  - mkdocs-click