Sphinx替换包含命令

时间:2014-03-31 09:23:18

标签: python-sphinx

我正在努力解决这个问题:

  • 我必须记录一个由C核心引擎和基于其构建的不同API组成的相当大的项目,比如Java,Python C#。

  • 必须为每个API单独部署文档,即每种语言,但99%的文档是相同的,只需要代码片段,示例主要需要更改。

  • 我通过定义全局变量来设置conf.py文件中的语言类型

  • 我使用了primary_domain和highlight_language来设置正确的语法高亮显示

  • 对于每个示例,我都有一个名称相同但扩展名不同的源文件

现在,我想说明一个使用literalinclude指令的例子,指定文件的名称,并根据使用的语言让其扩展名发生变化。我天真地尝试使用替换宏但没有成功:

rst_prolog = ".. |ext| replace:: .%s\n" % primary_domain

正确替换文档周围的|ext|,但不能在命令

中替换
.. literalinclude: filename|ext|

除了使用sed等解析rst文件外,我有什么方法可以做到这一点吗?

0 个答案:

没有答案