planet-auth-python/mkdocs.yml at main · planetlabs/planet-auth-python · 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
site_name: Planet Auth Library
site_description: Planet Auth Library
site_url: https://planet.com/
strict: true
dev_addr: 127.0.0.1:8001

#watch:
#  - src

theme:
  name: 'material'
  logo: img/logo-white.svg
  favicon: img/logo-color.svg
  custom_dir: 'docs/custom_theme/'
  features:
    - content.code.copy
    - navigation.expand
    - navigation.indexes
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: #007f99
      toggle:
        icon: octicons/moon-24
        name: Switch to dark mode
    - scheme: slate
      primary: #004352
      toggle:
        icon: octicons/sun-24
        name: Switch to light mode


hooks:
  - docs/hooks/mkdocs_hooks.py

plugins:
  - search:
  - macros:
      include_dir: 'docs/examples'
      on_error_fail: true
  - autorefs
  - mkdocstrings:
      handlers:
        python:
#          paths: [src/planet]
          options:
            show_root_heading: true
            inherited_members: true
            show_root_members_full_path: true
            show_object_full_path: true
            show_source: false
            show_bases: true
            # show_inheritance_diagram: true
            # show_submodules: true
            filters:
              - "!^_"  # exclude all members starting with _
              - "^__init__$"  # but always include __init__ modules and methods

repo_name: planetlabs/planet-auth-python
repo_url: https://github.com/planetlabs/planet-auth-python
#edit_uri: ""

nav:
  - Introduction: 'index.md'
  - CLI:
    - plauth: 'cli-plauth.md'
  - Library Usage:
    - Overview: 'library-overview.md'
    - Auth Client Configuration: 'configuration.md'
    - Built-in Injection: 'built-ins.md'
  - API Reference:
    - Planet Auth: 'api-planet-auth.md'
    - Planet Auth Utils: 'api-planet-auth-utils.md'
    - Planet Auth Config Injection: 'api-planet-auth-config-injection.md'
  - Examples:
    - Installation: 'examples-installation.md'
    - CLI: 'examples-cli.md'
    - Client Usage: 'examples-client.md'
    - Service Usage: 'examples-service.md'
  - Changelog: 'changelog.md'

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - mkdocs-click
  - admonition