toolbox-pyspark/mkdocs.yaml at main · data-science-extensions/toolbox-pyspark · 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
site_name: PySpark Toolbox
site_description: Helper files/functions/classes for generic PySpark processes
site_author: "[Chris Mahoney](mailto:chris@mahoneyconsultingservices.com)"
site_dir: web
docs_dir: docs
remote_branch: docs-site
repo_name: toolbox-pyspark
repo_url: https://github.com/data-science-extensions/toolbox-pyspark
edit_uri: edit/main/docs/

watch:
  - src/toolbox_pyspark
  - docs/
  - README.md

theme:
  name: material
  favicon: ./assets/images/spark.svg
  coverpage_icon: ./assets/images/spark.svg
  custom_dir: docs/overrides
  palette:
    primary: blue grey
    accent: indigo
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.suggest
    - toc.follow
    - content.action.edit
    - content.action.view
    - content.code.annotate
  logo: ./assets/images/spark.svg
  icon:
    repo: material/gitlab
    # logo: fontawesome/brands/spark
    edit: material/file-edit-outline
    view: material/file-eye-outline


nav:
  - Home: index.md
  - Usage:
      - Overview: usage/overview.md
      - Application: usage/application.md
      - Changelog: usage/changelog.md
      - Contributing: usage/contributing.md
  - Modules:
      - code/index.md
      - Constants: code/constants.md
      - IO: code/io.md
      - Checks: code/checks.md
      - Types: code/types.md
      - Keys: code/keys.md
      - Scale: code/scale.md
      - Dimensions: code/dimensions.md
      - Columns: code/columns.md
      - DateTime: code/datetime.md
      - Info: code/info.md
      - Formatting: code/formatting.md
      - Cleaning: code/cleaning.md
      - Duplication: code/duplication.md
      - Schema: code/schema.md
      - Delta: code/delta.md
      - Utils:
        - Exceptions: code/utils/exceptions.md
        - Warnings: code/utils/warnings.md
        - Whitespaces: code/utils/whitespaces.md


markdown_extensions:
  - admonition
  - meta
  - attr_list
  - md_in_html
  - toc:
      permalink: "🔗"
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.progressbar
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - assets/stylesheets/style.css
  - assets/stylesheets/admonitions.css
  - assets/stylesheets/code_chunks.css
  - assets/stylesheets/columns.css
  - assets/stylesheets/lists.css
  - https://site-assets.fontawesome.com/releases/v6.4.2/css/all.css

plugins:
  - search:
      lang: en
  - autorefs
  - mike:
      version_selector: true
      alias_type: copy
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          options:
            # extensions:
            #   - griffe_inherited_docstrings
            #   - docstring_inheritance.griffe
            allow_inspection: true
            docstring_style: google
            docstring_options:
              replace_admonitions: no
            show_root_heading: true
            show_root_toc_entry: false
            show_root_full_path: true
            show_source: true
            show_object_full_path: false
            separate_signature: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true
            show_if_no_docstring: true
            heading_level: 3
            members_order: source
            group_by_category: false
            filters:
              - "!^__all__"