本书基于名为 Jupyter Book 的 Python 工具构建,并部署在 GitHub Pages 上。本书主要内容使用 .ipynb
和 .md
文件保存。Jupyter Book 工具可以将 .ipynb
或 .md
文件转化为 HTML 格式。
文字和代码的规范和风格,请遵照 样式规范。
参考 Github Desktop 教程 或 Git 教程 创建 Fork,并将代码仓库克隆到本地。
git clone https://github.com/<username>/scale-py-zh.git
准备环境:
- 选择一个包管理工具,比如
conda
。 - 安装 Python >= 3.8
- 安装 requirements.txt 和 requirements-dev.txt 中的各个依赖。包括本书各个案例所需要的工具 pandas 等,以及本电子书构建工具 Jupyter Book:
conda create -n dispy
source activate dispy
conda install python=3.11 anaconda::graphviz
pip install -r requirements.txt
进入该项目文件夹,对项目进行构建:
sh build.sh
构建好 HTML 文件后,如果是在自己的个人电脑,可以使用 Python 自带的 HTTP Server,并在浏览器里打开 http://127.0.0.1:8000 查看效果:
cd docs
python -m http.server 8000
之后会在 _build
目录下生成各类网页相关文件。
本项目的 HTML 部署在 GitHub Pages 上,GitHub Pages 读取本项目中 docs
目录下内容。在生成 HTML 格式后,请检查 docs
目录下内容已更新。