问题描述
我正在尝试使用 Sphinx 结合阅读文档主题编写文档,但搜索功能似乎已损坏。
我在 Windows 10 上运行 Python 3.7 和最新版本的 Sphinx 和阅读文档主题(均通过pip install
)。构建页面并在浏览器中打开 index.html 后(尝试了 Edge 和 Chrome)我不是能够搜索我的离线文档。
搜索页面打开但只显示动画Search -> Search . -> Search .. -> Search …
Search -> Search . -> Search .. -> Search …
,如果我将主题改回标准主题,搜索工作没有任何问题。
由于搜索适用于标准主题,它似乎不是与浏览器相关的问题,也似乎与我没有在本地主机上托管页面这一事实有关。
如果我查看控制台中的错误,我会看到两个错误
jquery.js:4 Failed to load file:///C:/user/documentation/_build/html/searchindex.js:
Cross origin requests are only supported for protocol
schemes: http, data, chrome, chrome-extension, https.
和
searchtools.js:144 Uncaught ReferenceError: Stemmer is not defined
at Object.query (searchtools.js:144)
at Object.setIndex (searchtools.js:83)
at searchindex.js:1
在网上搜索时,我找不到任何有用的东西来解决这个问题。
同样刷新浏览器缓存( Ctrl + F5
),如也不起作用。
有没有人遇到过同样的问题?
1楼
我通过使用以下解决方案( )解决了这个问题。
归功于 GitHub 用户 @tk0miya。
首先,导航到 Python 安装文件夹并在./Lib/site-packages/sphinx_rtd_theme/layout.html
找到layout.html
。
然后替换第 191 - 204 行包含
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
LANGUAGE:'{{ language }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }},
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
通过以下代码
{% if sphinx_version >= "1.8.0" %}
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
{% else %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
LANGUAGE:'{{ language }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }},
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{% endif %}
然后在控制台的文档文件夹中运行make clean
和make html
。
在您的文档文件夹中执行控制台命令很重要。