python-testcompose/mkdocs.yml at main · rugging24/python-testcompose · 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
site_name: Testcompose
site_description: A lightweight  docker library for writing integration tests in Python.
site_url: https://rugging24.github.io/python-testcompose/

repo_url: https://github.com/rugging24/python-testcompose
repo_name: rugging24/python-testcompose
edit_uri: ""

theme:
  name: material
  palette:
    scheme: default
    primary: brown
    accent: amber
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - autorefs
  - search
  - mkdocstrings:
      handlers:
        python:
          selection:
            filters:
              - "!^_"
          rendering:
            show_root_heading: true
            show_source: true
            show_root_full_path: true
            show_object_full_path: false
            show_if_no_docstring: true
            show_signature_annotations: true
            show_root_members_full_path: false
            show_category_heading: false # shows the modules, classes , methods e.t.c
            show_bases: true
            setup_commands:
                - import sys, os
                - sys.path.insert(0, os.path.abspath('..'))
            selection:
                new_path_syntax: true
                inherited_members: true
      watch:
        - testcompose


markdown_extensions:
  - admonition
  - codehilite
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta


nav:
  - Introduction: 'index.md'
  - QuickStart: 'quickstart.md'
  - Environment Variables: 'environment_variables.md'
  - Developer Reference: 'api.md'

extra_css:
  - css/custom.css