wsadmin-type-hints/mkdocs.yml at main · LukeSavefrogs/wsadmin-type-hints · 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
site_name: "Python wsadmin"
site_description: "Python package providing type hints for wsadmin Jython commands."
site_author: "Luca Salvarani"

repo_url: https://github.com/LukeSavefrogs/wsadmin-type-hints

nav:
  - Home: index.md
  - Getting started:
    - getting_started/getting-started.md
    - getting_started/faq.md
    - getting_started/resources.md
    - getting_started/tips-n-tricks.md
  - Cookbook:
    - cookbook/index.md
    - Servers: cookbook/servers.md
    - Custom Properties: cookbook/custom_properties.md
  - API Reference: reference/

watch:
  - docs/
  - mkdocs.yml
  - src/        # Only used to preview the documentation

theme:
  name: material
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.tabs
    # - navigation.tabs
    - toc.follow
    - content.code.copy
    - content.tabs.link
    - navigation.sections
    - navigation.expand
    - search.highlight
    - search.share

  palette:
    # Palette toggle for light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-night
        name: Switch to light mode

plugins:
  # - mkdocs-simple-hooks:
  #     hooks:
  #       on_env: "docs.scripts.hooks:on_env"

  # Automatic code reference
  - mkdocstrings:
      custom_templates: docs/templates/
      handlers:
        python:
          paths: [src] # Recommended [by the docs](https://mkdocstrings.github.io/python/usage/#finding-modules:~:text=Except%20for%20case,on%20their%20filesystem.)

          # For more options: https://mkdocstrings.github.io/python/usage/#globallocal-options
          options:
            # Headings options:
            show_root_heading: false
            show_root_toc_entry: false

            # Members options:
            filters:
              - "!^__all__$"
              - "!^_" # Do not show hidden properties

            # Docstrings options:
            docstring_style: "google"
            docstring_section_style: "spacy"
            show_if_no_docstring: true
            # merge_init_into_class: true

            # Signatures/annotations options:
            show_signature: true
            # separate_signature: true

            # Additional options:
            show_source: false
            show_bases: true

            show_submodules: false

            # extensions:
            #   - docs.scripts.griffe_prune


  - gen-files:
      scripts:
      - docs/scripts/generate_api_reference.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index

  # Other plugins
  - search:
      lang: en

  - autorefs

  - git-revision-date-localized:
      enabled: !ENV [IS_PRODUCTION, true]
      enable_creation_date: true
      fallback_to_build_date: true
      type: timeago

extra:
  social:
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/wsadmin-type-hints/
      name: Visit the package homepage

    - icon: fontawesome/brands/github
      link: https://github.com/LukeSavefrogs
      name: Find me on Github

    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/lucasalvarani/
      name: Find me on LinkedIn

extra_css:
  - stylesheets/extra.css
  - stylesheets/material.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      title: On this page...
      permalink: true
      permalink_title: Anchor link to this section for reference
  - tables
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde


# See also https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin