Skip to content

维护与发布手册

只看三件事:怎么同步、怎么验证、脚本各管哪一层。正文模板规则见 template_guidelines.md

脚本分层

脚本作用
verifyverify.py统一验证入口
converttools/convert_notebook.py正文镜像主链路
synctools/sync_docs_index.pytools/sync_docs_navigation.py首页 / 导学页 / 组页同步
checktools/check_source_docs_mirror.pytools/check_chapter_links.py镜像和链接检查
testtools/test_chapter0_1_notebooks.pytools/test_notebook_answers.pyNotebook 校验
migrationtools/md_to_notebook.pymarkdown -> notebook 迁移辅助

tools/convert_chapter0_1.py 只保留 legacy 兼容。

日常流程

  1. 先改 source。
  2. 首页改动后跑 python tools/sync_docs_index.py
  3. 导学页 / 组页改动后跑 python tools/sync_docs_navigation.py
  4. 正文改动后跑 python tools/convert_notebook.py
  5. 最后跑 cd docs && npm run docs:build

常用命令

bash
python verify.py part0_1 --no-build
python verify.py part2 --no-build
python verify.py part3 --no-build
python verify.py part4 --no-build
python verify.py all --no-build
python tools/sync_docs_index.py
python tools/sync_docs_navigation.py
python tools/convert_notebook.py
cd docs && npm run docs:build

测试脚本索引

脚本作用
verifyverify.py统一验证入口
converttools/convert_notebook.py正文镜像主链路
synctools/sync_docs_index.pytools/sync_docs_navigation.py首页 / 导学页 / 组页同步
checktools/check_source_docs_mirror.pytools/check_chapter_links.py镜像和链接检查
checktools/check_docs_links.pytools/check_math_formula_symbols.pytools/check_part01_code_blocks.pydocs 链接、公式与代码块检查
testtools/test_chapter0_1_notebooks.pytools/test_notebook_answers.pyNotebook 校验
migrationtools/md_to_notebook.pymarkdown -> notebook 迁移辅助

推荐用法

bash
python verify.py part0_1 --no-build
python verify.py part2 --no-build
python verify.py part3 --no-build
python verify.py all --no-build
python tools/check_math_formula_symbols.py
python tools/check_part01_code_blocks.py

无 GPU 时,verify.py 会跳过 Part 2 / 3 的 GPU-only 答案验证,但仍保留转换、镜像和链接检查。单独排查时直接用底层脚本。 tools/md_to_notebook.py 仅用于历史迁移,不进入日常主流程。

说明

  • Part 0 / Part 1tools/test_chapter0_1_notebooks.py
  • Part 2 / Part 3tools/test_notebook_answers.py
  • 先改源,再同步 docs/
  • 导学页、组页、正文页分开同步
  • tools/convert_chapter0_1.py 只保留兼容用途
  • tools/md_to_notebook.py 只保留迁移辅助用途

Released under the MIT License.