File: mkdocs.yml

package info (click to toggle)
morecantile 7.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,036 kB
  • sloc: python: 3,339; makefile: 5
file content (117 lines) | stat: -rw-r--r-- 3,172 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
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
107
108
109
110
111
112
113
114
115
116
117
# Project Information
site_name: 'morecantile'
site_description: 'Construct and use map tile grids (a.k.a TileMatrixSet / TMS).'

docs_dir: 'src'
site_dir: 'build'

# Repository
repo_name: 'developmentseed/morecantile'
repo_url: 'https://github.com/developmentseed/morecantile'
edit_uri: 'blob/main/src/'
site_url: 'https://developmentseed.org/morecantile/'

# Social links
extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/developmentseed'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/developmentseed'

# Layout
nav:
  - Home: 'index.md'
  - Usage: 'usage.md'
  - Advanced:
    - Geographic Transformations: advanced/geographic.md
  - TMS v2: 'tms-v2.md'
  - API:
    - morecantile.commons: api/morecantile/commons.md
    - morecantile.defaults: api/morecantile/defaults.md
    - morecantile.errors: api/morecantile/errors.md
    - morecantile.models: api/morecantile/models.md
    - morecantile.utils: api/morecantile/utils.md
  - CLI: 'cli.md'
  - Benchmarking: benchmark.html
  - Development - Contributing: 'contributing.md'
  - Release: 'release-notes.md'

# Theme
theme:
  icon:
    logo: 'material/home'
    repo: 'fontawesome/brands/github'
  name: 'material'
  language: 'en'
  palette:
    primary: 'pink'
    accent:  'light pink'
  font:
    text: 'Nunito Sans'
    code: 'Fira Code'
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.share

plugins:
  - search
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          paths: [src]
          options:
            filters:
            - "!^__post_init__"
            docstring_section_style: list
            docstring_style: google
            line_length: 100
            separate_signature: true
            show_root_heading: true
            show_signature_annotations: true
            show_source: false
            show_symbol_type_toc: true
            signature_crossrefs: true
            extensions:
              - griffe_inherited_docstrings
          import:
            - https://docs.python.org/3/objects.inv
            - https://rasterio.readthedocs.io/en/stable/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://pyproj4.github.io/pyproj/stable/objects.inv

# These extensions are chosen to be a superset of Pandoc's Markdown.
# This way, I can write in Pandoc's Markdown and have it be supported here.
# https://pandoc.org/MANUAL.html
markdown_extensions:
    - admonition
    - attr_list
    - codehilite:
        guess_lang: false
    - def_list
    - footnotes
    - pymdownx.arithmatex
    - pymdownx.betterem
    - pymdownx.caret:
        insert: false
    - pymdownx.details
    - pymdownx.emoji
    - pymdownx.escapeall:
        hardbreak: true
        nbsp: true
    - pymdownx.magiclink:
        hide_protocol: true
        repo_url_shortener: true
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
        custom_checkbox: true
    - pymdownx.tilde
    - toc:
        permalink: true