textual-fspicker/mkdocs.yml at main · davep/textual-fspicker · 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
site_name: textual-fspicker
docs_dir: docs/source
repo_url: https://github.com/davep/textual-fspicker

nav:
  - Guide:
      - index.md
      - using.md
  - Library Contents:
      - library-contents/base_dialog.md
      - library-contents/file_dialog.md
      - library-contents/file_open.md
      - library-contents/file_save.md
      - library-contents/icons.md
      - library-contents/path_filters.md
      - library-contents/path_maker.md
      - library-contents/safe_tests.md
      - library-contents/select_directory.md
  - Change Log: changelog.md
  - License: license.md

watch:
  - src/textual_fspicker

markdown_extensions:
  - admonition
  - pymdownx.snippets
  - markdown.extensions.attr_list
  - pymdownx.superfences:
      custom_fences:
        - name: textual
          class: textual
          format: !!python/name:textual._doc.format_svg
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  search:
  autorefs:
  mkdocstrings:
    default_handler: python
    enable_inventory: true
    handlers:
      python:
        inventories:
          - https://docs.python.org/3/objects.inv
          - https://textual.textualize.io/objects.inv
          - https://rich.readthedocs.io/en/stable/objects.inv
        options:
          filters:
            - "!^_"
            - "^__.+__$"
            - "!^on_mount$"
            - "!^compose$"
          modernize_annotations: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_signature_annotations: false
          separate_signature: true
          signature_crossrefs: true
          merge_init_into_class: true
          parameter_headings: true
          show_root_heading: false
          docstring_options:
            ignore_init_summary: true
          show_source: false

theme:
  name: material
  icon:
    logo: fontawesome/solid/folder-tree
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.tabs.sticky
    - navigation.footer
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/davep
    - icon: fontawesome/brands/python
      link: https://pypi.org/user/davepearson/
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@davep
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/davep.org
    - icon: fontawesome/brands/threads
      link: https://www.threads.net/@davepdotorg
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@DavePearson
    - icon: fontawesome/brands/steam
      link: https://steamcommunity.com/id/davepdotorg

### mkdocs.yml ends here