PyRenew/mkdocs.yml at main · CDCgov/PyRenew · 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
site_name: "PyRenew"
repo_url: "https://github.com/CDCgov/PyRenew"

theme:
  name: "material"
  icon:
    repo: fontawesome/brands/github
  features:
    - content.tooltips
    - content.footnote.tooltips
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - offline
  - autorefs
  - awesome-pages
  - mkdocstrings:
      handlers:
        python:
          options:
            annotations_path: "brief"
            docstring_style: "numpy"
            line_length: 80
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true

          paths: ["."]
          inventories:
            - url: "https://docs.python.org/3/objects.inv"
            - url: "https://numpy.org/doc/stable/objects.inv"
            - url: "https://python.arviz.org/en/stable/objects.inv"
            - url: "https://num.pyro.ai/en/stable/objects.inv"
            - url: "https://docs.jax.dev/en/latest/objects.inv"
      enable_inventory: true

markdown_extensions:
  - toc:
      toc_depth: 2
  - footnotes
  - md_in_html
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: math
          class: arithmatex
          format:
            !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format {
              kwds: { mode: generic, tag: div },
            }
  - callouts

extra_javascript:
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
  - javascripts/katex.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css