栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

如何使用Python以编程方式生成Sphinx文档的一部分?

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

如何使用Python以编程方式生成Sphinx文档的一部分?

最后,我找到了实现自己想要的方法。这是操作方法:

  1. 创建一个python脚本 (我们称之为
    generate-includes.py
    ),该 脚本 将生成 reStructuredText 并将其保存在
    myrst.inc
    文件中。(在我的示例中,这将是脚本加载和解析YAML,但这无关紧要)。 确保此文件是可执行文件!!!
  2. include
    在要插入动态生成的文档的位置上, 使用 文档的主.rst文档中 伪指令

    .. include:: myrst.inc
  3. 修改sphinx Makefile ,以便在构建时生成所需的.inc文件:

    myrst.inc:./generate-includes.py

    html: myrst.inc
    …(other stuff here)

  4. 通常 使用来 构建文档

    make html



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/648019.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号