pytaskwarrior/mkdocs.yml at main · sznicolas/pytaskwarrior · 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: pytaskwarrior
site_description: A modern Python wrapper for TaskWarrior
site_url: https://pytaskwarrior.readthedocs.io
repo_url: https://github.com/sznicolas/pytaskwarrior
repo_name: sznicolas/pytaskwarrior

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - search.highlight

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            merge_init_into_class: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Building TaskWarrior: building-taskwarrior.md
  - API Reference:
      - TaskWarrior: api/taskwarrior.md
      - Data Models: api/dto.md
      - Enums: api/enums.md
      - Exceptions: api/exceptions.md
  - Examples:
      - Basic Usage: examples/basic.md
      - Contexts: examples/contexts.md
      - Advanced: examples/advanced.md
  - Tips & Tricks: tips-and-tricks.md
  - LLMs Guides:
      - Overview: llms/llms-taskwarrior.md
      - DTOs: llms/llms-dtos.md
      - Date Handling: llms/llms-dates.md
      - Task Patterns: llms/llms-task-patterns.md
      - Contexts: llms/llms-contexts.md
      - Recurring Tasks: llms/llms-recurring.md
      - UDAs: llms/llms-udas.md
      - Dependencies: llms/llms-dependencies.md
      - Error Handling: llms/llms-errors.md
      - Performance: llms/llms-performance.md
  - Troubleshooting: troubleshooting.md