Merge pull request #3150 from verilog-to-routing/fix_docs_search

Fix docs search

Author: AmirhosseinPoolad

doc/.gitignore

@@ -1,2 +1,3 @@
 #Sphinx
 _build
+.venv

doc/README

@@ -14,19 +14,22 @@ Currently VTR's documenation is automatically built by https://readthedocs.org/p
 How to build documentation
 --------------------------
 
-To build the documentation locally you need sphinx installed:
+To build the documentation locally you need to to install Doxygen (Optional) and the python dependencies. You can use your distribution's package manager to install Doxygen. Ubuntu and Debian users can use the following command:
 
-    For ubuntu/debian based systems:
+    $ sudo apt install doxygen
 
-        $ apt-get install python-sphinx
+While Fedora and RHEL users can use the following command:
 
-    To properly build citations and the bibliography, we use the sphinxcontrib-bibtex extension:
+    $ sudo dnf install doxygen
 
-        $ pip install sphinxcontrib-bibtex
+You can install python dependencies by fist optionally making a virtual environment:
 
-    To install all the python requirements:
+    $ python -m venv .venv
+    $ source .venv/bin/activate
 
-        $ pip install -r requirements.txt
+And then using the requirements file to install the dependencies:
+
+    $ pip install -r requirements.txt
 
 To build the documentation just run:
 

doc/requirements.txt

@@ -2,11 +2,12 @@
 # used by Read The Docs to install python required
 # modules with pip.
 
-sphinx<7
+# Pinned sphinx's version to avoid breakage in future
+sphinx == 8.2.3
 sphinx_rtd_theme
 
 # Support custom domains
-sphinxcontrib-domaintools
+git+https://github.com/AmirhosseinPoolad/sphinxcontrib-domaintools
 
 # Support Markdown
 sphinx-markdown-tables

doc/src/conf.py

@@ -67,13 +67,13 @@
 master_doc = "index"
 
 project = "Verilog-to-Routing"
-copyright = "2012-2022, VTR Developers"
+copyright = "2012-2025, VTR Developers"
 author = "VTR Developers"
 
 version = get_vtr_version()
 release = get_vtr_release()
 
-language = None
+language = "en"
 
 exclude_patterns = ["_build"]
 
@@ -87,8 +87,6 @@
 
 html_theme = "sphinx_rtd_theme"
 
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
 html_logo = "_static/vtr_logo.svg"
 
 html_favicon = "_static/favicon.ico"