python-pipeline/mkdocs.yml at main · thecodecrate/python-pipeline · 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
site_name: "TheCodeCrate's Pipeline"
site_url: "https://thecodecrate.github.io/python-pipeline"
repo_url: "https://github.com/thecodecrate/python-pipeline"

watch:
  - src

extra_css:
  - assets/css/extra.css
  - assets/css/extra-pymdownx.css

theme:
  name: material
  # logo: assets/images/logo.svg
  # favicon: assets/images/favicon.png
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/theme-light-dark
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: dracula
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to system preference

  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - toc.integrate
    - toc.follow
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.tabs
    - navigation.top
    - navigation.tracking

markdown_extensions:
  - markdown.extensions.attr_list:
  - markdown.extensions.md_in_html:
  - markdown.extensions.toc:
      anchorlink: true
      anchorlink_class: "toclink"
  - pymdownx.blocks.admonition:
      types:
        - new
        - settings
        - note
        - abstract
        - info
        - tip
        - success
        - question
        - warning
        - failure
        - danger
        - bug
        - example
        - quote
  - pymdownx.blocks.tab:
      alternate_style: True
      combine_header_slug: True
      slugify:
        !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
  - pymdownx.blocks.caption:
  - pymdownx.details:
  - pymdownx.snippets:
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      social_url_shortener: true
      normalize_issue_symbols: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      linenums_style: pymdownx-inline
      extend_pygments_lang:
        - name: pycon3
          lang: pycon
          options:
            python3: true

plugins:
  # - autorefs
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["src"]
          options:
            show_if_no_docstring: true
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: true
            docstring_section_style: list
            # docstring_section_style: spacy
            filters:
              - "!^_"
            heading_level: 1
            merge_init_into_class: true
            parameter_headings: true
            allow_inspection: true
            preload_modules: ["_lib", "thecodecrate_pipeline"]
            relative_crossrefs: true
            scoped_crossrefs: true
            separate_signature: true
            # line_length: 60
            show_bases: false
            # show_inheritance_diagram: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: false
            unwrap_annotated: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/thecodecrate/python-pipeline
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/thecodecrate-pipeline/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

nav:
  - Home: index.md
  - API Reference:
      - core: api/core.md
      - types: api/types.md
      - processors: api/processors.md