# book-the-first-step-of-programming

**Repository Path**: sn-yang/book-the-first-step-of-programming

## Basic Information

- **Project Name**: book-the-first-step-of-programming
- **Description**: 编程第一步，帮助编程初学者。
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-06
- **Last Updated**: 2024-06-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 编程第一步

## 介绍

写一些东西，来帮助编程的初学者。

## 配置开发环境

这个工程是使用 readthedocs 的来发布的, 所以建立在:

- python 3.10+
- poetry

```sh
# 安装 poetry
pip install --user poetry

# 安装 python 的依赖
poetry install

# 激活 python 虚拟环境
poetry shell
# 或者
source ./.venv/Scripts/activate

```

### 生成发布的文件

```sh
# 激活 python 虚拟环境
poetry shell

./make.sh html
```

## 项目从零的创建过程

> 不要在构建好的项目中执行

### 安装 python 包

```sh
pip install --user poetry

# 设置在项目内部生成虚拟环境
python -m poetry config virtualenvs.in-project true

# 初始化 pyproject.toml
python -m poetry init

# 安装，并激活 python 虚拟环境
python -m poetry install

# 在虚拟环境中安装 poetry
pip install poetry

# 增加需要的包
python -m poetry add sphinx
python -m poetry add sphinx-autobuild
python -m poetry add sphinx_rtd_theme
python -m poetry add sphinx_markdown_tables
python -m poetry add myst-parser

python -m poetry add rstcheck
python -m poetry add doc8
python -m poetry add docutils
python -m poetry add recommonmark
```

### 构建 readthedocs 项目

```sh
sphinx-quickstart
```