Documentation of rCore-Tutorial version 3 in Chinese.
- 2022.07.01 Welcome to JOIN Open-Source-OS-Training-Camp-2022 !
使用 venv(Python 3 内置):
python3 -m venv venv
source venv/bin/activate # Linux/Mac
# 或
venv\Scripts\activate # Windows或使用 conda:
conda create -n rcore-book python=3.10
conda activate rcore-bookpip install -U sphinx更多安装方式可参考 Sphinx 官方文档。
pip install -r requirements.txt如果使用国内镜像源(如 Tuna):
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simplemake html构建完成后,生成的文档位于 build/html 目录。
更多构建相关的详细信息可参考 环境配置与构建。
完整的流程示例:
# Fork 并克隆仓库
git clone --recursive https://github.com/YOUR_USERNAME/rCore-Tutorial-Book-v3.git
cd rCore-Tutorial-Book-v3
# (可选) 创建并激活虚拟环境
python3 -m venv venv
source venv/bin/activate
# 安装 Sphinx
pip install -U sphinx
# 安装依赖
pip install -r requirements.txt
# 构建文档
make html
# 查看生成的文档
# build/html/index.html