statworx-theme/mkdocs.yml at master · STATWORX/statworx-theme · 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
site_name: "Statworx Theme"
site_description: "A color theme for matplotlib using the offical statworx design"
copyright: Made with ❤ from Statworx
use_directory_urls: false
repo_url: https://github.com/STATWORX/statworx-theme
repo_name: STATWORX/statworx-theme

theme:
  palette:
    scheme: statworx
  name: material
  favicon: assets/favicon.jpg
  logo: assets/logo.svg
  icon:
    repo: fontawesome/brands/git-alt
  features:
    - content.tabs.link
    - search.highlight
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - content.code.annotate
    - toc.integrate
    - navigation.top

extra_css:
  - assets/css/extras.css
  - assets/css/style.css
  - assets/css/mkdocstrings.css

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/statworx
    - icon: fontawesome/brands/medium
      link: https://medium.com/@statworx_blog
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/statworx
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/statworx
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/statworx
    - icon: fontawesome/brands/xing
      link: https://www.xing.com/companies/statworx
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/statworx

markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - include-markdown
  - mkdocs_matplotlib
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          selection:
            docstring_style: google
            docstring_options:
              ignore_init_summary: yes
          rendering:
            merge_init_into_class: false
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            filters: []
      watch:
        - src
nav:
  - Overview: index.md
  - Gallery: gallery.md
  - Colormaps: colormap.md
  # - Changelog: changelog.md
  # - License: license.md
  # - Contribution: contribution.md
  - Code Documentation: code.md