MTC
latest
  • 1. MTC工具包开发
  • 2. 基因操作与合成生物学
  • 3. Matlab编程技术与应用
  • 4. Java编程技术与应用
  • 5. 写作技巧
  • 6. 课题组培训
  • 7. 汽爆工艺专栏(主编:杨帆)
  • 8. 食醋酿造专栏(主编:杨帆)
  • 9. Readthedocs构建与维护技巧
    • 9.1. 导入readthedocs常见问题
    • 9.2. 插入视频
    • 9.3. rst语法及md转rst方法
    • 9.4. rst语法介绍网站
    • 9.5. md转rst方法
    • 9.6. Readthedocs常用模板
MTC
  • Docs »
  • 9. Readthedocs构建与维护技巧
  • Edit on GitHub

9. Readthedocs构建与维护技巧¶

Contents

  • 9.1. 导入readthedocs常见问题
    • 9.1.1. 官方网站
    • 9.1.2. 主文件夹中需要添加一个readthedocs.yml文件
    • 9.1.3. 在配置过程中,出现WARNING: html_static_path 警告而导致失败
    • 9.1.4. 配制文件模板
  • 9.2. 插入视频
    • 9.2.1. 插入youtube视频(也非常好,只需要替换src部分–需要添加http:)
    • 9.2.2. 插入bilibili视频
    • 9.2.3. 为保障手机客户端观看效果
    • 9.2.4. 利用sphinxembeddedvideos添加youtube视频(实践证明:无法使用)
    • 9.2.5. 建议使用的模板
  • 9.3. rst语法及md转rst方法
  • 9.4. rst语法介绍网站
  • 9.5. md转rst方法
  • 9.6. Readthedocs常用模板
    • 9.6.1. 字体设置
    • 9.6.2. 细节设置
    • 9.6.3. 文章结构和目录
    • 9.6.4. 兼容Jupyter Notebook
    • 9.6.5. 列表
    • 9.6.6. 枚举
    • 9.6.7. 编号技巧
    • 9.6.8. 链接到当地文件
    • 9.6.9. 链接到阿里云服务器
    • 9.6.10. 段落两端对齐
Next Previous

© Copyright 2020, MTC Team Revision 5b17b812.

Built with Sphinx using a theme provided by Read the Docs.