Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/articles/api/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CLI Module

::: hatch.cli_hatch
3 changes: 3 additions & 0 deletions docs/articles/api/environment_manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Environment Manager

::: hatch.environment_manager
24 changes: 24 additions & 0 deletions docs/articles/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# API Reference

Welcome to the Hatch API Reference documentation. This section provides detailed documentation for all public APIs and modules in the Hatch package manager.

## Overview

Hatch is a comprehensive package manager for the Cracking Shells ecosystem. The API is organized into several key modules:

- **Core Modules**: Main functionality for CLI, environment management, package loading, etc.
- **Installers**: Various installation backends and orchestration components

## Getting Started

To use Hatch programmatically, you can import the main modules:

```python
from hatch import cli_hatch
from hatch.environment_manager import EnvironmentManager
from hatch.package_loader import PackageLoader
```

## Module Index

Browse the detailed API documentation for each module using the navigation on the left.
3 changes: 3 additions & 0 deletions docs/articles/api/installers/base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Base Installer

::: hatch.installers.installer_base
3 changes: 3 additions & 0 deletions docs/articles/api/installers/context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Installation Context

::: hatch.installers.installation_context
3 changes: 3 additions & 0 deletions docs/articles/api/installers/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Docker Installer

::: hatch.installers.docker_installer
3 changes: 3 additions & 0 deletions docs/articles/api/installers/hatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hatch Installer

::: hatch.installers.hatch_installer
3 changes: 3 additions & 0 deletions docs/articles/api/installers/orchestrator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Dependency Installation Orchestrator

::: hatch.installers.dependency_installation_orchestrator
3 changes: 3 additions & 0 deletions docs/articles/api/installers/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Python Installer

::: hatch.installers.python_installer
3 changes: 3 additions & 0 deletions docs/articles/api/installers/system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# System Installer

::: hatch.installers.system_installer
3 changes: 3 additions & 0 deletions docs/articles/api/package_loader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Package Loader

::: hatch.package_loader
3 changes: 3 additions & 0 deletions docs/articles/api/python_environment_manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Python Environment Manager

::: hatch.python_environment_manager
3 changes: 3 additions & 0 deletions docs/articles/api/registry_explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Registry Explorer

::: hatch.registry_explorer
3 changes: 3 additions & 0 deletions docs/articles/api/template_generator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Template Generator

::: hatch.template_generator
31 changes: 30 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,25 @@ site_url: https://crackingshells.github.io/Hatch/
repo_url: https://github.com/CrackingShells/Hatch
repo_name: CrackingShells/Hatch
docs_dir: docs
site_logo: resources/images/Logo/hatch_wide_light_bg_transparent.png

theme:
name: readthedocs

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

markdown_extensions:
- admonition
Expand Down Expand Up @@ -60,6 +72,23 @@ nav:
- 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
- API Reference:
- Overview: articles/api/index.md
- Core Modules:
- CLI: articles/api/cli.md
- 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
- 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
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ dependencies = [
"hatch_validator @ git+https://github.com/CrackingShells/Hatch-Validator.git@v0.7.1-dev.1"
]

[project.optional-dependencies]
docs = [
"mkdocs>=1.4.0",
"mkdocstrings[python]>=0.20.0"
]

[project.scripts]
hatch = "hatch.cli_hatch:main"

Expand Down