Hatch/mkdocs.yml at main · CrackingShells/Hatch · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
site_name: Hatch
site_description: Hatch is the package manager for the Hatch! ecosystem.
site_url: https://crackingshells.github.io/Hatch/
repo_url: https://github.com/CrackingShells/Hatch
repo_name: CrackingShells/Hatch
docs_dir: docs

theme:
  name: material
  custom_dir: overrides
  logo: https://raw.githubusercontent.com/CrackingShells/.github/main/resources/images/hatch_wide_light_bg_transparent.png
  favicon: https://raw.githubusercontent.com/CrackingShells/.github/main/resources/images/hatch_icon_light_bg_transparent.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: egg-shell
      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.tabs
    - navigation.top
    - toc.follow

extra_css:
  - stylesheets/brand.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_object_full_path: false
            show_category_heading: true
            show_labels: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
  - print-site  # Must be last to ensure print page has all plugin changes

markdown_extensions:
  - admonition
  - tables
  - fenced_code
  - attr_list
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Users:
      - Getting Started: articles/users/GettingStarted.md
      - CLI Reference: articles/users/CLIReference.md
      - MCP Host Configuration: articles/users/MCPHostConfiguration.md
      - Security & Trust: articles/users/SecurityAndTrust.md
      - Troubleshooting:
          - Report Issues: articles/users/Troubleshooting/ReportIssues.md
      - Tutorials:
          - Getting Started:
              - 01 Installation: articles/users/tutorials/01-getting-started/01-installation.md
              - 02 Create Env: articles/users/tutorials/01-getting-started/02-create-env.md
              - 03 Install Package: articles/users/tutorials/01-getting-started/03-install-package.md
              - 04 Checkpoint: articles/users/tutorials/01-getting-started/04-checkpoint.md
          - Environments:
              - 01 Manage Envs: articles/users/tutorials/02-environments/01-manage-envs.md
              - 02 Python Env: articles/users/tutorials/02-environments/02-python-env.md
              - 03 Checkpoint: articles/users/tutorials/02-environments/03-checkpoint.md
          - Author Package:
              - 01 Generate Template: articles/users/tutorials/03-author-package/01-generate-template.md
              - 02 Implement Functionality: articles/users/tutorials/03-author-package/02-implement-functionality.md
              - 03 Edit Metadata: articles/users/tutorials/03-author-package/03-edit-metadata.md
              - 04 Validate and Install: articles/users/tutorials/03-author-package/04-validate-and-install.md
              - 05 Checkpoint: articles/users/tutorials/03-author-package/05-checkpoint.md
          - MCP Host Configuration:
              - 01 Host Platform overview: articles/users/tutorials/04-mcp-host-configuration/01-host-platform-overview.md
              - 02 Configuring Hatch! Packages: articles/users/tutorials/04-mcp-host-configuration/02-configuring-hatch-packages.md
              - 03 Configuring Arbitrary MCP Servers: articles/users/tutorials/04-mcp-host-configuration/03-configuring-arbitrary-servers.md
              - 04 Environments & Hosts Synchronization: articles/users/tutorials/04-mcp-host-configuration/04-environment-synchronization.md
              - 05 Checkpoint: articles/users/tutorials/04-mcp-host-configuration/05-checkpoint.md
  - Developers:
      - Overview: articles/devs/index.md
      - Architecture:
          - Overview: articles/devs/architecture/index.md
          - System Overview: articles/devs/architecture/system_overview.md
          - Component Architecture: articles/devs/architecture/component_architecture.md
          - CLI Architecture: articles/devs/architecture/cli_architecture.md
          - MCP Host Configuration: articles/devs/architecture/mcp_host_configuration.md
          - MCP Host Backup System: articles/devs/architecture/mcp_backup_system.md
      - Contribution Guides:
          - Overview: articles/devs/contribution_guides/index.md
          - How to Contribute: articles/devs/contribution_guides/how_to_contribute.md
          - Release Policy: articles/devs/contribution_guides/release_policy.md
      - Development Processes:
          - Overview: articles/devs/development_processes/index.md
          - Developer Onboarding: articles/devs/development_processes/developer_onboarding.md
          - Testing Standards: articles/devs/development_processes/testing_standards.md
      - Implementation Guides:
          - Overview: articles/devs/implementation_guides/index.md
          - Adding CLI Commands: articles/devs/implementation_guides/adding_cli_commands.md
          - Adding Installers: articles/devs/implementation_guides/adding_installers.md
          - Installation Orchestration: articles/devs/implementation_guides/installation_orchestration.md
          - Package Loader Extensions: articles/devs/implementation_guides/package_loader_extensions.md
          - Registry Integration: articles/devs/implementation_guides/registry_integration.md
          - MCP Host Configuration Extension: articles/devs/implementation_guides/mcp_host_configuration_extension.md
  - API Reference:
      - Overview: articles/api/index.md
      - Core Modules:
          - Environment Manager: articles/api/environment_manager.md
          - Package Loader: articles/api/package_loader.md
          - Python Environment Manager: articles/api/python_environment_manager.md
          - Registry Explorer: articles/api/registry_explorer.md
          - Template Generator: articles/api/template_generator.md
      - CLI Package:
          - Overview: articles/api/cli/index.md
          - Entry Point: articles/api/cli/main.md
          - Utilities: articles/api/cli/utils.md
          - Environment Handlers: articles/api/cli/env.md
          - Package Handlers: articles/api/cli/package.md
          - MCP Handlers: articles/api/cli/mcp.md
          - System Handlers: articles/api/cli/system.md
      - Installers:
          - Base Installer: articles/api/installers/base.md
          - Docker Installer: articles/api/installers/docker.md
          - Hatch Installer: articles/api/installers/hatch.md
          - Python Installer: articles/api/installers/python.md
          - System Installer: articles/api/installers/system.md
          - Installation Context: articles/api/installers/context.md
          - Dependency Orchestrator: articles/api/installers/orchestrator.md
  - Appendices:
      - Overview: articles/appendices/index.md
      - Glossary: articles/appendices/glossary.md
      - Limits and Known Issues: articles/appendices/LimitsAndKnownIssues.md
      - State and Data Models: articles/appendices/state_and_data_models.md