Skip to content

Fix docs search #3150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+16 −13
Open

Fix docs search #3150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf8dd0c
Update doc/README.md for better package management
AmirhosseinPoolad Jun 18, 2025
4b59a9f
Update Sphinx version
AmirhosseinPoolad Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#Sphinx
_build
.venv
17 changes: 10 additions & 7 deletions doc/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
5 changes: 3 additions & 2 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 2 additions & 4 deletions doc/src/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]

Expand All @@ -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"
Expand Down