如何使用-D参数为sphinx-build指定html_theme_path?

时间:2012-09-04 12:18:28

标签: python-sphinx

我正在使用Sphinx来生成我的一些项目的文档。我编写了一个简单的构建脚本,克隆了所有的git repos,找到了docs目录并执行:

sphinx-build -b html -D html_theme=treffynnon -D html_theme_path=/home/user/_themes /home/user/sphinx/src /home/user/output/docs

不幸的是,虽然html_theme设置正确,但html_theme_path却没有。这当然会导致Sphinx在无法找到主题时吐出错误。

我应该如何格式化此命令?甚至可以用这种方式指定html_theme_path吗?

1 个答案:

答案 0 :(得分:0)

这看起来像是一个已知错误:https://bitbucket.org/birkenfeld/sphinx/issue/925/allow-html_theme_path-to-be-provided-to

要解决这个问题,我刚用sed在配置文件中为我做了替换:

sed -i "s|#*html_theme = '.*'|html_theme = 'simonholywell'|g" conf.py                
sed -i "s|#*html_theme_path = .*$|html_theme_path = ['$BASE_DIR/sphinx/_themes']|g" conf.py

由于我的Sphinx项目都是git,我可以做一个:

git checkout -- conf.py

在完成构建过程后删除sed引入的更改。