Metadata-Version: 2.1
Name: zood
Version: 0.0.9
Summary: web page documentation & comment generation documentation
Home-page: https://github.com/luzhixing12345/zood
License: MIT
Author: kamilu
Author-email: luzhixing12345@163.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyYAML (>=6.0,<7.0)
Project-URL: Documentation, https://luzhixing12345.github.io/zood/
Project-URL: Repository, https://github.com/luzhixing12345/zood
Description-Content-Type: text/markdown

# zood

Github仓库网页文档 + 注释生成文档

## [主题预览](https://luzhixing12345.github.io/zood/)

## 快速开始

### 1.安装

```bash
pip install zood
```

### 2.运行

进入当前项目根目录

- 根据markdown文档生成网页

  ```bash
  zood -g ./docs
  ```

  > `docs` 为markdown文档文件夹名

- 根据代码注释生成网页文档

  ```bash
  zood -c
  ```

### 3.查阅[配置文档](https://luzhixing12345.github.io/zood/)

```bash
zood -h
```

## 开发

```bash
poetry build
```

```bash
poetry config pypi-token.pypi my-token
```

```bash
poetry publish
```

