# script

**Repository Path**: gemini524/script

## Basic Information

- **Project Name**: script
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-28
- **Last Updated**: 2022-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用

> 运行之前确认已安装：
>
> - python>=3.7
> - git
> - pandoc
> - doxygen

1. 配置环境变量`msdocs_check_dir`作为工作目录。

    ```bash
    export msdocs_check_dir=/home/useranme/xxx`
    ```

2. 在`msdocs_check_dir`目录下创建配置文件`config.ini`。

    ```text
    [EmailConfig]
    email_server_host = smtp.qq.com
    email_server_port = 587
    email_user =
    email_password =
    mail_from =
    mail_to =
    api_mail_title = MindSpore API变更每日统计
    doc_mail_title = MindSpore文档生成报错每日统计
    display_name = MindSporeDocsLinter
    ```

    其中：

    - email_server_host = 邮件服务器域名
    - email_server_port = 端口
    - email_user = 用户名
    - email_password = 密码(注意国内邮箱需要 授权码)
    - mail_from = 发件人邮箱地址
    - mail_to = 收件人邮箱地址
    - api_mail_title = MindSpore API变更每日统计
    - doc_mail_title = MindSpore文档生成报错每日统计
    - display_name = MindSporeDocsLinter

3. 运行：

    ```bash
    python ms_doc_lint --time="08:00"
    ```

    其中`--time`为设定检测时间。