登录社区云,与社区用户共同成长
邀请您加入社区
这个插件会为生成后的文档添加 .nojekyll 文件, 也会为 GitHub Pages 自定义域名添加 CNAME 文件。如果没有 .nojekyll, GitHub Pages 会认为 _ 开头的文件夹是 jekyll 内部文件夹, 然后将它过滤掉。build:文件夹,当你执行make html的时候,生成的html静态文件都存放在这里。make.bat:windows平台用于编译文档项目的
使用shpinx编写文档有如下优点:使用sphinx编写的文档可以方便地制作html、pdf等格式,非常方便浏览和转换。sphinx支持rst和markdown语法,方便共享及开源编辑,使用git也方便跟踪。由于rst语法比markdown语法更强大和方便,我们主要采用rst语法编写文档, linux内核源码文档也是使用rst格式编写的。我们的文档也支持markdown,主要是为了方便不熟悉rst