latform/mkdocs.yml at main · ken-lauer/latform · 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
site_name: latform
repo_url: https://github.com/ken-lauer/latform
repo_name: ken-lauer/latform

nav:
  - Home: index.md
  - CLI Reference: cli.md
  - Python API: api.md
  - Style Guide: style_guide.md
  - Development: development/development_guidelines.md

theme:
  icon:
    repo: fontawesome/brands/github
  name: readthedocs
  custom_dir: docs/overrides
  features:
    - navigation.top
    - navigation.tabs
    - navigation.indexes

markdown_extensions:
  - markdown.extensions.extra
  - pymdownx.highlight
  - pymdownx.superfences
  - tables
  - toc:
      permalink: true

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ken-lauer/latform
      name: latform

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  # - macros
  - autorefs:
      resolve_closest: true

  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          inventories:
            - https://rich.readthedocs.io/en/latest/objects.inv
          options:
            allow_inspection: true
            filters:
              - "!^_" # exclude all members starting with _
              - "^__init__$" # but always include __init__ modules and methods
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: false
            heading_level: 3
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: false
            show_object_full_path: true
            show_category_heading: true
            show_if_no_docstring: false
            show_signature: true
            signature_crossrefs: true
            show_signature_annotations: false
            separate_signature: true
            line_length: 100
            merge_init_into_class: true
            show_source: true
            show_bases: true
            show_submodules: false
            group_by_category: true
            unwrap_annotated: true
          rendering:
            show_source: true
            show_root_heading: true