sphinx-quickstart生成的_includes、_static、_templates默认文件夹有什么作用?
Sphinx 三个默认文件夹用途及存放内容说明
_static文件夹
该文件夹用来存储所有无需Sphinx渲染处理的静态资源,构建文档时文件夹内的所有内容会直接原封不动复制到输出站点的_static目录下。
适合存放的内容:自定义CSS样式、JS脚本、文档用到的图片、字体、可下载的附件(比如PDF、压缩包)等。你在rst文件中引用这类资源时,直接用相对路径指向该目录下的对应文件即可。_templates文件夹
该文件夹用来存储自定义的Jinja2模板,作用是覆盖Sphinx默认主题自带的模板,实现页面结构、布局的自定义调整。
适合存放的内容:修改后的页脚模板、头部导航模板、侧边栏模板、特定类型页面的专属渲染模板等。只要你自定义的模板文件名和Sphinx默认模板的文件名保持一致,构建时就会自动优先使用你存放在这里的自定义模板。_includes文件夹
该文件夹用来存储可复用的reStructuredText片段,你可以在任意文档中通过include指令导入这些片段,避免重复编写相同内容。
适合存放的内容:通用版权声明、版本说明、通用警告提示、跨多文档复用的表格、代码块等内容。比如你所有文档末尾都需要加的免责声明,就可以单独存为一个rst文件放在这里,其他文档只需一行指令即可引入,后续修改也只需要改这一个文件。
内容的提问来源于stack exchange,提问作者Mathieu
相关产品推荐
相关产品推荐

