qubership-pipelines-common-python-library/mkdocs.yml at main · Netcracker/qubership-pipelines-common-python-library · 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
site_name: "Qubership Pipelines Common Library"
watch: [mkdocs.yml, README.md, qubership_pipelines_common_library/]

theme:
  name: "mkdocs"
  include_homepage_in_sidebar: false
  user_color_mode_toggle: true

nav:
  - Home: mkdocs/index.md
  - Clients: mkdocs/clients.md
  - Context: mkdocs/context.md
  - Commands: mkdocs/commands.md
  - Maven: maven_auth.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            #            docstring_options:
            #              ignore_init_summary: true
            docstring_section_style: "list" # table/spacy
            filters: ["!^_"]
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: false
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: false # true also looks good
            show_if_no_docstring: false
            members_order: "source"

markdown_extensions:
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.extra