sphinx 高级功能介绍
发布时间
阅读量:
阅读量
关于sphinx的具体定义在此不再赘述,但在实际应用过程中遇到了一些问题,现将相关经验整理如下,以供借鉴。最初计划编写一份类似wiki格式的标准化文档,发现许多企业均采用sphinx进行构建,在学习和实践过程中产生了一些疑问,并最终逐一解决,具体总结如下:
1,变量的运用方式,在conf.py文件中需遵循特定格式进行定义:
rst_epilog="""
.. |pnamex| replace:: wiki test project.
.. |pnamex3| replace:: pnamex3 test project.
.. |xxx| replace:: xxx for something.
"""
AI写代码python
运行
随后在正文部分,通过使用|pnamex|即可完成变量的替换操作,需注意上方的rst_epilog内容为固定设置;目前尚未查证是否存在其他可行方式,但经过测试表明其他方法均无法实现。
上述为全局变量的应用方式,若仅需在文中局部使用,则可直接在相应位置进行定义,其使用方法与全局变量一致。
.. |pname| replace:: wiki test project.
全部评论 (0)
还没有任何评论哟~
