binned-cdf/mkdocs.yml at main · famura/binned-cdf · 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
copyright: "Fabio Muratore"
edit_uri: "edit/main/docs"
repo_name: "binned-cdf"
repo_url: "https://github.com/famura/binned-cdf"
site_author: "Fabio Muratore"
site_description: "A PyTorch-based distribution parametrized by the logits of CDF bins"
site_dir: .site
site_name: "binned-cdf"
site_url: "https://famura.github.io/binned-cdf"

nav:
  - Getting Started:
      - index.md
      - Installation: installation.md
  - Reference: reference.md
  - Changelog: changelog.md
  - Development:
      - Getting Started: development/getting_started.md
      - Installation: development/installation.md
      - Coverage: exported/coverage
      - Tests: exported/tests
  - Licenses: licenses.md

theme:
  name: material
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - header.autohide
    - navigation.expand
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  font: false
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      accent: amber
      media: "(prefers-color-scheme: light)"
      primary: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      accent: amber
      media: "(prefers-color-scheme: dark)"
      primary: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - mkdocs-typer
  - toc:
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - docs/glossary.md
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - git-revision-date-localized:
      fallback_to_build_date: true
  - macros:
      module_name: docs/macros
  - mike:
      alias_type: copy
      canonical_version: latest
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            heading_level: 3
            show_root_heading: true
            show_source: true
  - search

extra:
  generator: false
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  # Sortable tables (see https://squidfunk.github.io/mkdocs-material/reference/data-tables)
  - https://unpkg.com/tablesort/dist/tablesort.min.js
  - js/tablesort.js

  # MathJax (see https://squidfunk.github.io/mkdocs-material/reference/mathjax)
  - js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js