微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

有没有办法将一段特定的代码添加到几个 sphinx-doc 项目中?

如何解决有没有办法将一段特定的代码添加到几个 sphinx-doc 项目中?

我们有超过 70 个 sphinx-doc 项目并使用自定义 .sh 文件来构建它们。在这个 sh 文件中覆盖了几个 sphinx 参数(认在 conf.py 文件中指定)。撇开其他细节不谈,我们用于构建文档的脚本部分如下所示:

for DOC_PATH in ${LIST};

do

  sphinx-build \
      -D html_theme=$THEME_NAME \
      -D html_theme_path=$ROOT_PATH \
      
      [..]

done

现在,我们需要更改从 menuselection 指令生成的符号,并将此更改应用于所有现有和进一步创建的文档。

将以下 Python 代码添加conf.py效果很好:

from sphinx.roles import MenuSelection

MenuSelection.BULLET_CHaraCTER = '\N{RIGHTWARDS ARROW}' 

但我们不想在所有 conf.py 文件中保留此代码。相反,我们更愿意将其保存在一个地方(如果您让我这样说,则作为单一来源)并以某种方式从我们的 .sh 文件添加它。

是否有可能使用 -D sphinx-build 参数完成此操作?或者也许我们应该更深入地研究 Sphinx 文档,有人可以指出另一个解决方案?如果可能,我们不希望触及源 sphinx-doc 代码

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。