festo-pgva/mkdocs.yml at main · Festo-se/festo-pgva · 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
site_name: PGVA 1 Python Driver Documentation
site_url: https://festo-se.github.io/festo-pgva/
repo_url: https://github.com/Festo-se/festo-pgva

site_dir: public
docs_dir: docs

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: System preference

    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Light mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Dark mode

  logo: img/Festo_Logo_Caerul_Web.svg
  favicon: img/method.png
  features: navigation.sections
    content.code.copy
    content.tooltips

use_directory_urls: true

markdown_extensions:
  - abbr
  - attr_list
  - footnotes
  - pymdownx.highlight:
      anchor_linenums: true
      linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: class
          class: highlight
          format: !!python/name:pymdownx.highlight.highlight

plugins:
  - codeinclude
  - search
  - include-markdown
  - autorefs:
      resolve_closest: true
  - mkdocs-autoapi:
      autoapi_dir: src
      autoapi_add_nav_entry: true
      autoapi_generate_api_docs: true
      autoapi_file_patterns:
        - "*.py"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
            - examples
          options:
            show_source: true
            docstring_style: google
            # extensions:
            # - griffe_typingdoc
            # show_root_heading: true
            # show_if_no_docstring: true
            # preload_modules:
            # - httpx
            # - starlette
            # inherited_members: true
            # members_order: source
            # separate_signature: true
            # unwrap_annotated: true
            # filters:
            # - '!^_'
            # merge_init_into_class: true
            # docstring_section_style: spacy
            # signature_crossrefs: true
            # show_symbol_type_heading: true
            # show_symbol_type_toc: true
  #   #enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
  #   #custom_templates: templates
  #

extra_css:
  - css/extra.css
  - https://www.festo.com/fonts/fonts.css

nav:
  - Home: "index.md"
  - Examples:
      - Basic usage: "examples/examples.md"
  - Festo Resources:
      - "PGVA Product Page": "https://www.festo.com/us/en/p/pressure-vacuum-generator-id_PGVA/"
      - "PGVA Data Sheet (en)": "https://www.festo.com/assets/attachment/en/661576"
  - Issues Tracker:
      - "Report and Issue with package": "https://github.com/Festo-se/festo-pgva/issues"