在reathedocs.org上的python-sphinx网站的破碎搜索字段

时间:2015-11-17 20:55:14

标签: python-sphinx read-the-docs

我发现了我网站最新版本的搜索功能 在readthedocs.org上托管的 eswp3.org 不再有效。我使用默认值 搜索python-sphinx html主题 sphinx_rtd_theme 的功能。我使用默认的makefile来构建html文件。

一些可能的错误导致调查:

  • 网站版本v1.1和网站版本v1.0的搜索字段已损坏。
  • 在网站版本V0.1中,搜索字段正在运行。 (版本可能会被切换 在网站左下角的字段。)
  • 重建website sources v1.0并在本地文件系统上重建 v1.0的搜索字段不起作用,v0.1的搜索字段确实有效。
  • 比较网站源v1.0和v0.1会导致以下差异:

To the diff screenshot

  • 我检查了conf.py的差异,但我没有发现重大差异。
  • 我删除了_build / html中的文件,并用。重建了文件 python-sphinx默认在根目录eswp3 / on中创建目标make html 我的本地文件系统。没有打印关于索引的问题。
  • 不幸的是,生成的版本中的搜索字段也无效。

我错过了什么?我是否必须考虑不同构建中使用的python-sphinx版本的可能差异?

提前多多感谢。

2 个答案:

答案 0 :(得分:0)

在Windows机器上编辑的某些文件尚未作为UTF-8格式文件提交给github,而是最初或在文件编辑后提交给WINDOWS-1252格式文件。将所有* .rst文件转换为UTF-8完成了这项工作(例如,通过使用find . -name "*.rst" -exec iconv -f WINDOWS-1252 -t UTF-8 {} -o utf-8/{} \;将UNIX上当前目录的所有* .srt文件转换为子文件夹/ utf-8。)

答案 1 :(得分:0)

修改C:\Python27\Lib\site-packages\sphinx_rtd_theme\layout.html

中的以下代码

<强>未定影:

164 <script type="text/javascript">
165 var DOCUMENTATION_OPTIONS = {
166    URL_ROOT:'{{ url_root }}',
167    VERSION:'{{ release|e }}',
168    COLLAPSE_INDEX:false,
169    FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
170    HAS_SOURCE:  {{ has_source|lower }}
171 };

<强>固定

164 <script type="text/javascript">
165 var DOCUMENTATION_OPTIONS = {
166    URL_ROOT:'{{ url_root }}',
167    VERSION:'{{ release|e }}',
168    COLLAPSE_INDEX:false,
169    FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
170    HAS_SOURCE:  {{ has_source|lower }},
171    SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
172 };