sphinx 部分高级功能汇总说明

本文总结了Sphinx的部分高级功能,包括变量使用、条件式文档生成、插件创建、多版本管理以及添加页面反馈。通过实例展示了如何在conf.py中定义变量,使用`.. only::`标签区分不同版本内容,创建自定义插件,以及利用环境变量实现多版本管理。同时,提到了添加页面反馈的方法,通过修改layout.html模板实现。
摘要由CSDN通过智能技术生成

什么是sphinx 就不说了,在探索sphinx 中踩了一些坑,汇总出来供参考。原本是打算写一份类似于wiki的标准文档,看到了很多企业使用了sphinx来创建,然后在学习中产生了一些疑惑,并解决了,总结如下:

1,变量的使用,在conf.py 按照如下格式定义:

rst_epilog="""
.. |pnamex| replace:: wiki test project.  
.. |pnamex3| replace:: pnamex3 test project.  
.. |xxx| replace:: xxx for something.
"""

然后在正文中用|pnamex| 就可以直接实现变量替换,注意上面的rst_epilog是固定内容;没有查询过是否可以有其他,但是测试其他是不行的。

上面是全局的变量使用,如果只是文内使用,直接在文内定义,使用方法一样。

.. |pname| replace:: wiki test project.   

关于变量的使用,官方文档地址:

The build configuration file — Sphinx 1.3.1 documentation

2,条件式生产文档

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值