SpotAPI/mkdocs.yml at main · Aran404/SpotAPI · 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
site_name: SpotAPI
site_description: Build Spotify tools in Python. Typed async results, no developer API key for public data, and explicit account and player scopes.
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://spotapi.readthedocs.io/en/latest/"]
repo_url: https://github.com/Aran404/SpotAPI
repo_name: Aran404/SpotAPI
edit_uri: edit/main/docs/
copyright: SpotAPI is independent of Spotify. Metadata and media remain subject to their owners' rights.

theme:
  name: material
  language: en
  font: false
  palette:
    scheme: slate
    primary: green
    accent: light green
  icon:
    logo: material/music-note
    repo: fontawesome/brands/github
  features:
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

nav:
  - Start here:
      - Overview: index.md
      - First result: quickstart.md
      - Coming from Spotipy: from-spotipy.md
  - Build something:
      - Catalogue and search: catalogue.md
      - Discovery, previews and captions: discovery.md
      - Accounts and playlists: account.md
      - Player controls and events: player.md
      - Studio: studio.md
  - Reference:
      - Python API: reference.md
      - Request and retry policy: transport.md
      - API layout: api-layout.md
      - Verification boundaries: player-coverage.md
      - Release checks: release-checks.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            docstring_style: google
            inherited_members: false

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

exclude_docs: |
  /development/
  /research/
  /code-quality-review.md
  /growth-and-coverage.md
  /independent-review.md
  /release-audit.md

extra_css:
  - stylesheets/extra.css