dgpy-libs/mkdocs.yml at main · dynamic-graphics-inc/dgpy-libs · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
site_name: dgpy-libs
docs_dir: docs
site_dir: public
site_url: ''
repo_url: 'https://github.com/dynamic-graphics-inc/dgpy-libs/'
repo_name: 'GitHub'
site_author: 'jesse rubin <jesse@dgi.com> & dan costello <dan@dgi.com>'
copyright: 'Dynamic Graphics Inc'
remote_branch: 'gh-pages'
watch:
  - libs/aiopen/src/aiopen
  - libs/asyncify/src/asyncify
  - libs/fmts/src/fmts
  - libs/funkify/src/funkify
  - libs/h5/src/h5
  - libs/jsonbourne/src/jsonbourne
  - libs/listless/src/listless
  - libs/requires/src/requires
  - libs/shellfish/src/shellfish
  - libs/xtyping/src/xtyping


nav:
  # - Home: './index.md'
  - Libs:
      - Home: './index.md'
      - aiopen: './libs/aiopen/README.ipynb'
      - asyncify: './libs/asyncify/README.ipynb'
      - funkify: './libs/funkify/README.ipynb'
      - h5: './libs/h5/README.ipynb'
      - jsonbourne: './libs/jsonbourne/README.ipynb'
      - lager: './libs/lager/README.ipynb'
      - requires: './libs/requires/README.ipynb'
      - xtyping: './libs/xtyping/README.ipynb'
  - API:
      - aiopen: './libs/aiopen/aiopen.api.md'
      - asyncify: './libs/asyncify/asyncify.api.md'
      - fmts: './libs/fmts/fmts.api.md'
      - funkify: './libs/funkify/funkify.api.md'
      - h5: './libs/h5/h5.api.md'
      - requires: './libs/requires/requires.api.md'
      - listless: './libs/listless/listless.api.md'
      - jsonbourne: './libs/jsonbourne/jsonbourne.api.md'
      - shellfish: './libs/shellfish/shellfish.api.md'
      - xtyping: './libs/xtyping/xtyping.api.md'
  # - Notebooks:
  #     - Cache Money: './notebooks/cache_money.ipynb'
  #     - Filter None: './notebooks/filter_none.ipynb'
  #     - JSON "parsing": './notebooks/json_parsing.ipynb'
  #     - String Formatting: './notebooks/string_fmt.ipynb'

theme:
  name: 'material'
  logo: 'images/dgpy_white_edge_small.png'
  favicon: images/favicon.png

  icon:
    repo: fontawesome/brands/github-alt
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search
    - search.highlight
    - search.suggest
    - toc.follow
    - toc.integrate

markdown_extensions:
  - attr_list
  - admonition
  - callouts
  - footnotes
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.tilde
  - pymdownx.magiclink
  - pymdownx.escapeall
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.tasklist
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.betterem:
      smart_enable: all
  - toc:
      permalink: ⚓︎

plugins:
  - search:
      lang: en
  - mkdocs-jupyter:
      execute: false
  ### MKDOCSTRINGS ###
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          paths:
            - libs/aiopen
            - libs/asyncify
            - libs/fmts
            - libs/funkify
            - libs/h5
            - libs/jsonbourne
            - libs/requires
            - libs/listless
            - libs/shellfish
            - libs/xtyping
          inherited_members: true
          docstring_style: google
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true