datajudge/mkdocs.yml at main · Quantco/datajudge · 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
site_name: datajudge
site_description: Assessing whether data from database complies with reference information.
site_url: https://quantco.github.io/datajudge
theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: indigo
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
      primary: indigo
  features:
    - content.action.edit
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy
    - navigation.tabs
  icon:
    repo: fontawesome/brands/github-alt
    edit: material/pencil
repo_name: quantco/datajudge
repo_url: https://github.com/quantco/datajudge
edit_uri: edit/main/docs/
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
            - "!src/datajudge/db_access.py"
          options:
            docstring_section_style: spacy
            docstring_style: numpy
            merge_init_into_class: true
            unwrap_annotated: true
            separate_signature: true
            show_if_no_docstring: true
            show_signature_annotations: true
            show_submodules: true
            show_symbol_type_heading: true
            filters:
              - "!^_" # exclude private and dunder elements
              - "!db_access"

nav:
  - installation.md
  - getting-started.md
  - testing.md
  - motivation.md
  - Examples:
      - examples/company-data.md
      - examples/twitch.md
      - examples/dates.md
      - examples/exploration.md
  - development.md
  - api-documentation.md
  - Changelog: CHANGELOG.md

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.arithmatex:
      generic: true

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

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