Skip to content

conanxin/CAD-CAM-Technology-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CAD/CAM Technology Docs

《CAD/CAM技术基础》课程化学习文档 - 现代化 Sphinx 文档站

项目一句话定位

一个从《CAD/CAM 技术基础》阅读笔记演进而来的现代化工程学习站,覆盖课程基础、FreeCAD 实操、STEP/STL 数据交换、CAM/G-code、Capstone 项目、CadQuery 代码化建模与 Assembly 装配体作品集。

项目状态

快速入口表

入口 链接
在线站点 https://conanxin.github.io/CAD-CAM-Technology-docs/
项目展示页(V10A 新增) https://conanxin.github.io/CAD-CAM-Technology-docs/project-showcase.html
工具链路线图 https://conanxin.github.io/CAD-CAM-Technology-docs/workflow-roadmap.html
FreeCAD 实操线 https://conanxin.github.io/CAD-CAM-Technology-docs/examples/freecad-workflow-index.html
Capstone 项目线 https://conanxin.github.io/CAD-CAM-Technology-docs/examples/capstone-learning-path.html
CadQuery 学习路径 https://conanxin.github.io/CAD-CAM-Technology-docs/examples/cadquery-learning-path.html
Assembly 学习路径 https://conanxin.github.io/CAD-CAM-Technology-docs/examples/cadquery-assembly-learning-path.html
Runtime / Portfolio 路线 https://conanxin.github.io/CAD-CAM-Technology-docs/examples/cadquery-runtime-portfolio-path.html
GitHub Releases https://github.com/conanxin/CAD-CAM-Technology-docs/releases

当前版本亮点

模块 说明
现代文档站 基于 Sphinx + Furo 主题,支持中文搜索、数学公式、响应式布局
8 章课程结构 完整覆盖 CAD/CAM 概论、建模、图形变换、工程分析、CAPP、数控编程、系统集成
学习辅助 课程总览、章节地图、复习题、词汇表、学习路径
工程案例 3 个完整制造案例:CAD→G-code、数据交换、CAPP 工艺路线
G-code 教学 逐行解释 + 路径可视化,帮助初学者理解数控程序
工作流路线图 工具链总览、四阶段学习路线、文件格式决策指南、3 个低门槛实践任务
Capstone 项目线 五步学习路线、产出物清单、完成标准
Python + CadQuery 代码化参数建模示例、STEP/STL 导出、参数化教学
CadQuery 进阶特征 圆角/倒角/孔阵列/支架变体的进阶示例
CadQuery 支架 Capstone 完整 L 型支架代码化(与 V6A 几何一致),作为 V6 作品集代码化补充
CadQuery 学习路径 V7 系列(V7A/V7B/V7C)三步走总入口和收口页
CadQuery Assembly 入门 多零件装配体表达、Location 概念、Assembly 容器
Assembly BOM 与检查清单 装配体 BOM 表格、爆炸图理解、装配检查清单
Assembly Placement mini-lab 定位、Location、嵌套子装配、教学型干涉检查
Assembly 学习路径 V8 系列(V8A/V8B/V8C)三步走总入口和收口页
Capstone 作品集升级 V6/V7/V8 三线整合(FreeCAD + CadQuery + Assembly 综合作品集)
CadQuery 运行试点 CadQuery 真实运行环境诊断、运行结果、读者本地指导
CadQuery 本地环境指南 conda/pip 路线、smoke test、导出后检查、本地导出工作流
CadQuery 运行与作品集路线 V9 系列发布收口、三步路线、文件与脚本地图、运行记录、教学诚信
首页 Showcase 化(V10A) Hero / 六大入口 / 推荐阅读路径 / 能力矩阵 / v1.0 路线图
项目全景页(V10A) project-showcase.rst 全站模块与演进时间线

项目能力矩阵

能力维度 内容 版本
课程基础 8 章完整教材 V2
课程导航 总览、地图、路径 V2
学习检验 复习题、词汇表 V2
工程案例 3 个完整制造流程 V3
G-code 教学 逐行解释 + 路径可视化 V4A
格式实验 STEP/STL 对比 mini-lab V4B
工具链认知 路线图、格式决策、实践任务 V4C
FreeCAD 实操 建模练习 + STEP/STL 导出指南 V5A
FreeCAD 导出检查 导出检查清单 + 资源包 V5B
FreeCAD 到 CAM CAM 任务规划 + 工作单模板 V5C
FreeCAD 五步路线 五步学习路线 + 收口页 V5D
L 型支架 Capstone 集成项目 + 5个阶段 V6A
项目档案与评分 项目档案 + 评分表 + 资源包 V6B
FreeCAD Path Workbench Job/Tool/Operation 入门 V6C
Capstone 项目线 五步路线 + 收口页 V6D
Python + CadQuery 代码化建模示例 + 参数化教学 V7A
CadQuery 进阶特征 圆角/倒角/孔阵列/支架变体 V7B
CadQuery 支架 Capstone 完整 L 型支架代码模型,与 V6A 几何一致 V7C
CadQuery 学习路径 V7 系列收口、三步走总览 V7D
CadQuery Assembly 入门 多零件装配体表达、Location 概念 V8A
Assembly BOM 与检查清单 装配体 BOM、爆炸图、检查清单 V8B
Assembly Placement mini-lab 定位、子装配、干涉检查 V8C
Assembly 学习路径 V8 系列收口、三步走总览 V8D
Capstone 作品集升级 V6/V7/V8 三线整合 V9A
CadQuery 运行试点 环境诊断、运行结果 V9B
CadQuery 本地环境指南 conda/pip 路线、smoke test、导出检查 V9C
CadQuery 运行与作品集路线 V9 系列发布收口、三步路线、文件地图、运行记录 V9D
运行诊断 环境诊断、真实运行结果 V9B
本地导出工作流 conda/pip 路线、smoke test、验证脚本 V9C
作品集运行记录 runtime-notes、local-export-log、教学诚信 V9D
V9 系列发布收口 三步路线、文件地图、5 层运行状态 V9D
Showcase 首页 Hero / 入口矩阵 / 推荐路径 / 能力矩阵 / v1.0 路线图 V10A
Showcase 项目全景页 project-showcase.rst 全站模块与演进时间线 V10A
Showcase CSS 增强 轻量 CSS 改善视觉层次 V10A

教学亮点速览

G-code 逐行解释(V4A):逐行解读数控程序 + SVG 路径可视化,让初学者"看到"机床动作 → 查看

STEP/STL mini-lab(V4B):同一零件导出两种格式,对比文件结构与几何表达 → 查看

工作流路线图(V4C):四阶段学习路线 + 文件格式决策表 + 3 个低门槛实践任务 → 查看

Python + CadQuery(V7A):代码化参数建模示例 + 与 FreeCAD 对比,读者可学习如何用 Python 描述几何 → 查看

CadQuery 进阶(V7B):圆角/倒角/孔阵列/支架变体的进阶特征示例,理解代码化建模的完整能力 → 查看

CadQuery 支架 Capstone(V7C):用代码重写 V6A 支架,参数与几何严格一致,作品集代码化补充 → 查看

CadQuery 学习路径(V7D):V7 系列三步走总入口、4 个 .py 代码文件地图、路线对比 → 查看

CadQuery Assembly 入门(V8A):多零件装配体表达、Assembly 容器、Location 概念 → 查看

Assembly BOM 与检查清单(V8B):BOM 表格、爆炸图理解、装配检查清单 → 查看

Assembly Placement mini-lab(V8C):Location/Placement、嵌套子装配、教学型干涉检查 → 查看

Assembly 学习路径(V8D):V8 系列三步走总入口、2 个 .py 代码 + 5 个资源包文件地图 → 查看

Capstone 作品集升级(V9A):V6/V7/V8 三线整合、升级版作品集结构、推荐文件夹结构 → 查看

CadQuery 运行试点(V9B):环境诊断、6 个 .py 实际运行结果、读者本地如何生成 → 查看

CadQuery 本地环境指南(V9C):conda/pip 路线、smoke test、导出后检查、environment-cadquery.yml → 查看

CadQuery 运行与作品集路线(V9D):V9 系列发布收口、三步路线、文件与脚本地图、真实运行状态说明、教学诚信 → 查看

项目全景展示(V10A):全站模块与演进时间线、读者类型入口、Showcase 入口表 → 查看

版本演进

  • v1.0.0(2026-07):稳定版发布——基于 V10B 全站质量审计 + V10C 最终发布收口 + V10D rc1 验证,正式发布 v1.0.0 stable。tag v1.0.0 + GitHub Release(latest)
  • V10D(2026-07):rc1 验证 + v1.0.0 stable 发布——验证 rc1 全通过,创建正式 v1.0.0 tag + GitHub Release(latest=true),保留 v1.0.0-rc1 prerelease
  • V10C(2026-07):最终发布收口——release notes v1.0.0 草案 + v1.0.0 release checklist + README v1.0.0-ready
  • V10B(2026-07):全站质量审计——Sphinx 0 warning / py_compile 10/10 / 47 HTML / 3,654 引用 0 broken / 13/13 HTTP 200
  • V10A(2026-07):首页 Showcase 化 + project-showcase 全景页 + 轻量 CSS + 2 SVG(site-showcase-map + v1-roadmap)
  • V9D(2026-07):CadQuery 运行与作品集路线发布收口(三步学习路线、9 个核心资源文件地图、真实运行状态说明、教学诚信、8 项完成标准、2 个新 SVG)
  • V9C(2026-07):CadQuery 本地环境配置指南(conda/pip 路线、smoke test、导出后检查、environment-cadquery.yml、3 个辅助脚本)
  • V9B(2026-07):CadQuery 真实运行与 STEP/STL 导出试点(环境诊断表、6 个 .py 实际运行结果、为什么 OCCT 不可用、读者本地如何生成、1 个资源包)
  • V9A(2026-07):Capstone 作品集升级(V6/V7/V8 三线整合、升级版作品集结构、推荐文件夹结构、V6/V7/V8 对照表、自评升级清单、2 个资源包)

v1.0 Roadmap

从 v0.9.x 推进到 v1.0 稳定版的路线:

阶段 主题 主要交付 Tag
V10A 首页与 Showcase 首页视觉升级 + project-showcase 全景页 + 轻量 CSS + 2 SVG v0.10.0-homepage-showcase(✅ 完成)
V10B 全站质量审计 死链 / 拼写 / Sphinx 0 warning / HTML CSS 验证 / SVG 引用检查 v0.10.1-full-site-quality-audit(✅ 完成)
V10C 最终发布收口 README 最终版、release notes、v1.0.0 release checklist、GitHub Release 完整 v1.0.0-rc1(✅ 完成)
v1.0.0 稳定版 长期支持里程碑、CI/CD 完整 v1.0.0(✅ 已发布)

本地构建

# 安装依赖
python -m pip install -r requirements.txt

# 构建文档
sphinx-build -b html . _build/html

# 或者使用 Makefile
make html

构建完成后,打开 _build/html/index.html 查看首页(含 Hero / 六大入口 / 推荐阅读路径 / 能力矩阵 / v1.0 路线图)。

技术栈

  • Sphinx - 文档构建工具
  • Furo - 现代文档主题
  • jieba - 中文搜索分词
  • MathJax - 数学公式渲染
  • showcase.css(V10A 新增)- 首页视觉层次增强

内容结构

  • 首页(V10A):Hero / 六大入口 / 推荐阅读路径 / 能力矩阵 / v1.0 路线图
  • 项目全景(V10A):project-showcase.rst 全站模块与演进时间线
  • 基础课程:course-overview → unit1 → unit2 → unit3 → unit4 → unit5 → unit6 → unit7 → unit8
  • 学习辅助:chapter-map、glossary、practice-questions、learning-path
  • 工程案例:cad-to-gcode、data-exchange、capp-process-plan
  • FreeCAD 实操线:freecad-plate-modeling → freecad-export-checklist → freecad-to-cam-worksheet → freecad-workflow-index
  • Capstone 项目线:bracket-capstone-project → bracket-project-portfolio → capstone-learning-path
  • CadQuery 代码建模线:cadquery-parametric-modeling → cadquery-advanced-features → cadquery-bracket-capstone → cadquery-learning-path
  • Assembly 装配体线:cadquery-assembly-intro → cadquery-assembly-bom-checklist → cadquery-assembly-placement-mini-lab → cadquery-assembly-learning-path
  • Runtime / Portfolio 路线:capstone-portfolio-upgrade → cadquery-runtime-export-pilot → cadquery-local-environment-guide → cadquery-runtime-portfolio-path

后续完善方向

  • STEP/STL 格式对比实验(mini-lab)
  • G-code 逐行解释与路径可视化
  • 增加工程案例(CAD→G-code、数据交换、CAPP)
  • 增加 G-code / STEP / STL 示例
  • 增加代码示例(Python + CadQuery)- V7A
  • V10A 首页 Showcase 化 + project-showcase 全景页
  • V10B 全站质量审计
  • V10C 最终发布收口
  • v1.0.0 稳定版
  • 加入真实软件截图(SolidWorks / FreeCAD / Fusion)
  • 增加 FreeCAD / Fusion / Mastercam 工具链示例
  • 补充更多图示和公式
  • 引入 Mermaid 流程图

贡献

欢迎提交 Issue 或 PR。

About

使用sphinx整理的《CAD/CAM技术基础》这本书的文档

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors