cosy-luigi/properdocs.yml at develop · cls-python/cosy-luigi · 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
site_name: CoSy-Luigi
site_description: Pipeline Synthesis
site_author: Constantin Chaumet
site_url: https://cls-python.github.io/cosy-luigi
repo_name: cls-python/cosy-luigi
repo_url: https://github.com/cls-python/cosy-luigi
edit_uri: blob/main/docs
copyright: 'Copyright &copy; <a href="https://github.com/Jekannadar">Constantin Chaumet</a>: 2025-present'

docs_dir: docs
site_dir: site
extra_css:
  - stylesheets/extra.css
theme:
  name: material
  custom_dir: docs/.overrides
  language: en
  favicon: assets/images/logo.svg
  icon:
    repo: fontawesome/brands/github
    logo: material/pipe-disconnected
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-off-outline
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky

nav:
  - Home:
    - About: index.md
    - Getting Started: quick-start.md
  - Examples: examples/
  - Code Reference: reference/
  - About:
    - Authors: about/authors.md

watch:
- src/cosy_luigi
- examples

plugins:
  search: {}
  gen-files:
    scripts:
      - scripts/gen_reference_pages.py
      - scripts/gen_example_pages.py
  literate-nav:
    nav_file: SUMMARY.md
  minify:
    minify_html: true
  mkdocstrings:
    default_handler: python
    handlers:
      python:
        paths: [src, examples]
        options:
          show_root_heading: true
          show_root_full_path: false
          show_if_no_docstring: true
          show_signature_annotations: true
          show_bases: false
          backlinks: tree
          show_inheritance_diagram: true
          extensions:
            - dataclasses
            - unpack_typeddict
            - griffe_generics
  git-revision-date-localized:
    type: date
    strict: false

markdown_extensions:
  - attr_list:
  - admonition:
  - tables:
  - md_in_html:
  - toc:
        permalink: true
  - pymdownx.details:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      guess_lang: false
      default_lang: python
  - pymdownx.inlinehilite:
      style_plain_text: python
  - pymdownx.snippets:
  - pymdownx.superfences:
  - pymdownx.blocks.tab:
      alternate_style: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cls-python/cosy-luigi