python-sphinx 网站在 reathedocs.org 上的搜索字段损坏
broken search field of python-sphinx website on reathedocs.org
我发现我网站最新版本的搜索功能
在 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有以下区别:
- 我检查了 conf.py 中的差异,但没有发现关键差异。
- 我删除了 _build/html 中的文件并用
python-sphinx 默认make target
make html
在根目录eswp3/上
我的本地文件系统。没有打印关于索引的问题。
- 不幸的是,生成的版本中的搜索字段也不起作用。
我错过了什么?我是否必须考虑不同版本中使用的 python-sphinx 版本可能存在的差异?
非常感谢。
某些在 windows 机器上编辑的文件尚未提交到 github 作为 UTF-8 格式文件,但最初或在文件编辑后提交到 WINDOWS-1252 格式文件。将所有 *.rst 文件转换为 UTF-8 即可完成工作(例如,使用 find . -name "*.rst" -exec iconv -f WINDOWS-1252 -t UTF-8 {} -o utf-8/{} \;
将 UNIX 上当前目录的所有 *.srt 文件转换为子文件夹 /utf-8)。
修改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 };
我发现我网站最新版本的搜索功能 在 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有以下区别:
- 我检查了 conf.py 中的差异,但没有发现关键差异。
- 我删除了 _build/html 中的文件并用
python-sphinx 默认make target
make html
在根目录eswp3/上 我的本地文件系统。没有打印关于索引的问题。 - 不幸的是,生成的版本中的搜索字段也不起作用。
我错过了什么?我是否必须考虑不同版本中使用的 python-sphinx 版本可能存在的差异?
非常感谢。
某些在 windows 机器上编辑的文件尚未提交到 github 作为 UTF-8 格式文件,但最初或在文件编辑后提交到 WINDOWS-1252 格式文件。将所有 *.rst 文件转换为 UTF-8 即可完成工作(例如,使用 find . -name "*.rst" -exec iconv -f WINDOWS-1252 -t UTF-8 {} -o utf-8/{} \;
将 UNIX 上当前目录的所有 *.srt 文件转换为子文件夹 /utf-8)。
修改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 };