什么是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,条件式生产文档