diff --git a/docs/build_docs/source/conf.py b/docs/build_docs/source/conf.py index 1bc9f8facb3..2210dd07cab 100644 --- a/docs/build_docs/source/conf.py +++ b/docs/build_docs/source/conf.py @@ -34,10 +34,12 @@ "sphinx.ext.coverage", "sphinx.ext.autosummary", "sphinx_md", + "sphinx_rtd_theme", "autoapi.extension", "sphinx.ext.napoleon", "sphinx.ext.githubpages", "sphinx.ext.linkcode", + "sphinxcontrib.jquery", ] autoapi_dirs = ["../../neural_compressor"] diff --git a/docs/build_docs/sphinx-requirements.txt b/docs/build_docs/sphinx-requirements.txt index 51d3751bde8..16ca9c6d058 100644 --- a/docs/build_docs/sphinx-requirements.txt +++ b/docs/build_docs/sphinx-requirements.txt @@ -1,6 +1,10 @@ -recommonmark -sphinx==6.1.1 -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 index 7d3a82ffd08..ed998c58b97 100644 --- a/docs/build_docs/update_html.py +++ b/docs/build_docs/update_html.py @@ -56,11 +56,34 @@ def update_source_url(version, folder_name, index_file): 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 = '' + version_list = """ + + + + + + + """ + 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):