nflreadpy/mkdocs.yml at main · nflverse/nflreadpy · 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
site_name: nflreadpy
site_description: A Python package for downloading NFL data from nflverse repositories
site_url: https://nflreadpy.nflverse.com
repo_url: https://github.com/nflverse/nflreadpy
repo_name: nflverse/nflreadpy

theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  logo: assets/nflverse.png
  favicon: assets/nflverse.png

  palette:
    - scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - content.code.copy

nav:
  - Home: index.md
  - API Reference:
    - Load Functions: api/load_functions.md
    - Configuration: api/configuration.md
    - Cache Management: api/cache.md
    - Utilities: api/utils.md
  - Changelog: CHANGELOG.md
  - Automation Status: https://nflreadr.nflverse.com/articles/nflverse_data_schedule.html
  - Data Dictionaries: https://nflreadr.nflverse.com/articles/index.html
  - nflverse GitHub: https://github.com/nflverse

not_in_nav: |
  CONTRIBUTING.md
  LICENSE.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 2