Metadata-Version: 2.1
Name: sphinx-easy
Version: 0.1.0
Summary: 简易 Sphinx 文档生成工具
Author: KG
Author-email: zhoukaige18@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.1.8,<9.0.0)
Requires-Dist: myst-parser (>=4.0.1,<5.0.0)
Requires-Dist: sphinx (>=8.2.3,<9.0.0)
Requires-Dist: sphinx-markdown-builder (>=0.6.8,<0.7.0)
Description-Content-Type: text/markdown

# sphinx-easy

简易 Sphinx 文档生成工具

## 项目介绍

sphinx-easy 是一个简化 Sphinx 文档生成过程的命令行工具，旨在让用户能够快速创建和管理文档项目。

## 安装指南

1. 确保已安装 Python 3.11 或更高版本
2. 使用 Poetry 安装依赖：

```bash
poetry install
```

## 使用说明

1. 初始化 Sphinx 项目：

```bash
sphinx-easy init
```

2. 构建文档：

```bash
sphinx-easy build
```

## 贡献指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 本项目
2. 创建新分支 (`git checkout -b feature/your-feature-name`)
3. 提交更改 (`git commit -am 'Add some feature'`)
4. 推送到分支 (`git push origin feature/your-feature-name`)
5. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。
