nbdev_build_docs运行正常但Github Pages文档渲染异常、模块链接缺失
nbdev GitHub Pages样式异常、模块链接缺失排查方案
- 首先核查项目根目录下
settings.ini的站点配置参数:doc_baseurl必须填写为仓库名前缀斜杠的格式,你的项目对应值应为/mat2np,参数错误会导致CSS样式文件、跳转链接的路径生成错误,直接引发样式丢失、链接失效问题。 - 进入仓库Settings的Pages配置页,确认部署源选择的是
gh-pages分支的根目录,若错误选择main分支会直接加载非构建产物的内容,出现样式异常。 - 核对本地安装的nbdev版本与你参考的教程版本是否一致:nbdev v1和v2版本的构建逻辑、产物结构差异极大,版本不匹配会出现无报错但产出不符合预期的情况,可运行
nbdev --version查看当前版本,卸载重装对应版本即可。 - 确认你执行了完整的构建流程:需先运行
nbdev_prepare生成模块索引、关联跳转关系,再运行nbdev_docs构建文档产物,缺失prepare步骤会直接导致模块跳转链接无法生成。 - 切换到仓库的
gh-pages分支,检查是否存在完整的html、css、js产物文件,若文件缺失可重新执行构建命令后推送到远端即可。
内容的提问来源于stack exchange,提问作者Simon B
相关产品推荐
相关产品推荐

