nighthawk-python/mkdocs.yml at main · kurusugawa-computer/nighthawk-python · 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
site_name: Nighthawk
site_description: An experimental Python library that embeds Natural blocks inside Python functions and executes them using an LLM.
site_url: https://kurusugawa-computer.github.io/nighthawk-python/
repo_url: https://github.com/kurusugawa-computer/nighthawk-python
repo_name: kurusugawa-computer/nighthawk-python

theme:
  name: material
  logo: assets/nighthawk_logo-128x128.png
  favicon: assets/nighthawk_logo-128x128.png
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.instant
    - navigation.sections
    - navigation.footer
    - search.suggest
    - search.highlight

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kurusugawa-computer/nighthawk-python
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/nighthawk-python/

copyright: "&copy; 2026 Kurusugawa Computer Inc."

exclude_docs: |
  AGENTS.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: true
            inventory_enabled: true

nav:
  - Home: index.md
  - Getting started:
      - Quickstart: quickstart.md
      - Natural blocks: natural-blocks.md
      - Executors: executors.md
      - Runtime configuration: runtime-configuration.md
  - Patterns & verification:
      - Patterns: patterns.md
      - Verification: verification.md
  - Configuration:
      - Pydantic AI providers: pydantic-ai-providers.md
      - Coding agent backends: coding-agent-backends.md
  - Reference:
      - Specification: specification.md
      - API Reference: api.md
      - For coding agents: for-coding-agents.md
  - Background:
      - Philosophy: philosophy.md
  - Project:
      - Roadmap: roadmap.md

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