tinify/mkdocs.yml at main · GeorgePearse/tinify · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
site_name: Tinify
site_description: A PyTorch library and evaluation platform for end-to-end learned compression
site_url: https://georgepearse.github.io/tinify/
repo_url: https://github.com/GeorgePearse/tinify
repo_name: GeorgePearse/tinify

docs_dir: docs/mkdocs
site_dir: site

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            signature_crossrefs: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - Techniques: techniques.md
  - Tutorials:
    - Training Models: tutorials/training.md
    - Custom Models: tutorials/custom-models.md
  - API Reference:
    - api/index.md
    - Models: api/models.md
    - Entropy Models: api/entropy-models.md
    - Latent Codecs: api/latent-codecs.md
    - Layers: api/layers.md
    - Losses: api/losses.md
    - Metrics: api/metrics.md
    - Datasets: api/datasets.md
    - Transforms: api/transforms.md
    - Operations: api/ops.md
  - Model Zoo:
    - Pre-trained Models: model-zoo/index.md
    - Performance Benchmarks: model-zoo/benchmarks.md
  - CLI Reference: cli/usage.md
  - References: references.md