fix search issue of online doc (#1687)

* fix search issue of online doc * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: ZhangJianyu <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
intel · Aug 13, 2024 · 408e5f1 · 408e5f1
1 parent dbd809b
commit 408e5f1
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 9 deletions.
diff --git a/docs/build_docs/source/conf.py b/docs/build_docs/source/conf.py
@@ -34,11 +34,13 @@
         'sphinx.ext.coverage',
         'sphinx.ext.autosummary',
         'sphinx_md',
+        'sphinx_rtd_theme',
         'autoapi.extension',
         'sphinx.ext.napoleon',
         'sphinx.ext.githubpages',
-        "sphinx.ext.linkcode",
-        'breathe'
+        'sphinx.ext.linkcode',
+        'breathe',
+        'sphinxcontrib.jquery',
         ]
 
 autoapi_dirs = ['../../intel_extension_for_transformers']

diff --git a/docs/build_docs/sphinx-requirements.txt b/docs/build_docs/sphinx-requirements.txt
@@ -1,8 +1,12 @@
 breathe
-recommonmark
-setuptools_scm[toml]>=6.2
-sphinx
-sphinx-autoapi
-sphinx-markdown-tables
-sphinx-md
-sphinx_rtd_theme
+recommonmark==0.7.1
+setuptools_scm[toml]==8.1.0
+sphinx==7.3.7
+sphinx-autoapi==3.1.0
+sphinx-autobuild==2024.4.16
+sphinx-markdown-tables==0.0.17
+sphinx-md==0.0.4
+sphinx_rtd_theme==2.0.0
+sphinxcontrib-jquery==4.1
+sphinxemoji==0.3.1
+
diff --git a/docs/build_docs/update_html.py b/docs/build_docs/update_html.py
@@ -50,11 +50,33 @@ def update_source_url(version, folder_name, index_file):
     with open(index_file, "w") as f:
         f.write(index_buf)
 
+def update_search(folder):
+    search_file_name="{}/search.html".format(folder)
+
+    with open(search_file_name, "r") as f:
+        index_buf = f.read()
+        key_str='<script src="_static/searchtools.js"></script>'
+        version_list = '''<!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+    <![endif]-->
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=fc837d61"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/js/theme.js"></script>
+    <script src="_static/searchtools.js"></script>'''
+        index_buf = index_buf.replace(key_str, version_list)
+
+    with open(search_file_name, "w") as f:
+        f.write(index_buf)
+
 def main(folder, version):
     folder_name=os.path.basename(folder)
     for index_file in glob.glob('{}/**/*.html'.format(folder),recursive = True):
         update_version_link(version, folder_name, index_file)
         update_source_url(version, folder_name, index_file)
+    update_search(folder)
 
 def help(me):
     print("python {} html_folder version".format(me))