# Read-the-Docs with Gitee

[![Documentation Status](https://readthedocs.org/projects/getstarted/badge)](https://readthedocs.org/projects/getstarted/builds)
[![Repository Size](https://img.shields.io/github/repo-size/zhyantao/getstarted)](https://github.com/zhyantao/getstarted/archive/refs/heads/master.zip)
[![GitHub Release](https://img.shields.io/github/v/release/zhyantao/getstarted)](https://github.com/zhyantao/getstarted/releases)
[![GitHub Issues](https://img.shields.io/github/issues/zhyantao/getstarted)](https://github.com/zhyantao/getstarted/issues)
[![GitHub Stars](https://img.shields.io/github/stars/zhyantao/getstarted)](https://github.com/zhyantao/getstarted)

## 环境部署

1、在 Gitee 上创建仓库（仓库名以 `notebook` 为例），创建完成后，克隆 `notebook` 到本地。

```bash
git clone https://gitee.com/<your_gitee_username>/notebook.git
```

2、将 [源代码压缩包](https://gitee.com/zhyantao/readthedocs/repository/archive/master.zip) 解压后，把压缩包中的内容全部复制到 `notebook` 文件夹中。

3、Windows 用户需安装 [GTK](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer)，Ubuntu 用户需安装 `libcairo2 libcairo2-dev`。

4、安装项目所需依赖，预览效果。

```bash
cd notebook
pip install -r requirements.txt
# export PATH=~/.local/bin:$PATH
make html
```

5、提交 `notebook` 仓库的修改到 Gitee。

```bash
git add . && git commit -m "v1.0.0" && git pull && git push
```

6、登录 [Readthedocs](https://readthedocs.org/) 导入刚刚新建的 Gitee 项目 `notebook`，构建完成后方可阅读文档。

## 撰写文档

1、把需要发表的文档放在 `notebook/docs` 文件夹中（写作格式可以是 [`Markdown`](./c02/c02_01) 或者 [`reStructuredText`](./c02/c02_02)）

2、打开命令行，并切换到 `notebook` 目录下，输入 `make html`

3、打开 `notebook/build/html/index.html` 预览效果，确认无误后提交代码到 Gitee 仓库

4、重新打开 [Readthedocs](https://readthedocs.org/) 文档的网址，查看新发表的博客（有延迟，可能需要等待）。

## 注意事项

在 `notebook/docs` 下的添加新文章后需要在 `notebook/docs/index.md` 中添加一条记录。


```{toctree}
:caption: 我的博客
:maxdepth: 2
:glob:
:hidden:

preface
chapters/*
```