edspdf-poppler/mkdocs.yml at main · aphp/edspdf-poppler · 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
site_name: EDSPDF-POPPLER

repo_url: https://github.com/aphp/edspdf-poppler

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  logo: assets/logo/edspdf-white.svg
  favicon: assets/logo/edspdf-blue.svg
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.indexes
    - content.code.annotate

nav:
  - index.md
  - Code Reference: reference/

extra_css:
  - assets/stylesheets/extra.css
  - assets/termynal/termynal.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6
  - assets/termynal/termynal.js

watch:
  - edspdf_poppler

hooks:
  - docs/scripts/plugin.py

extra:
  version:
    provider: mike

plugins:
  - search
  - autorefs:
      priority:
        - '*'
        - reference
  - mkdocstrings:
      enable_inventory: true
      custom_templates: docs/assets/templates
      handlers:
        python:
          import:
            - https://aphp.github.io/edspdf/latest/objects.inv
            - https://aphp.github.io/edspdf-mupdf/latest/objects.inv
          filters: [ "!poppler_src" ]
          options:
            docstring_style: numpy
            docstring_section_style: spacy
            heading_level: 2
            members_order: source
            show_root_toc_entry: false
            show_signature: false
            merge_init_into_class: true
  - mike

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - footnotes
  - md_in_html
  - attr_list
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg