From e74c8372eab60d209210ced962b9fb77b78763ce Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Mon, 22 Sep 2025 19:56:39 -0400 Subject: [PATCH] Commentary: Python venv --- docs/guide/conf.py | 8 ++++++-- docs/guide/install.rst | 10 ++++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/guide/conf.py b/docs/guide/conf.py index 33ce181ac..82f857c59 100644 --- a/docs/guide/conf.py +++ b/docs/guide/conf.py @@ -63,10 +63,14 @@ rst_prolog = """ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. +# # To install: # sudo install enchant -# sudo pip3 install sphinx sphinx_rtd_theme breathe sphinxcontrib-spelling -# We keep this list empty for now to avoid needing dependencies +# python3 -m venv --system-site-packages ~/.verilator_pyenv +# source ~/.verilator_pyenv/bin/activate +# pip3 install sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe +# +# We keep this extensions list empty for now to avoid needing dependencies extensions = [] # extensions = ['breathe', 'sphinxcontrib.spelling'] diff --git a/docs/guide/install.rst b/docs/guide/install.rst index aa73b7e99..4dd2fd3c3 100644 --- a/docs/guide/install.rst +++ b/docs/guide/install.rst @@ -158,9 +158,15 @@ Those developing Verilator itself also need these (see internals.rst): sudo apt-get install clang clang-format-18 cmake gdb gprof graphviz lcov sudo apt-get install python3-clang python3-distro yapf3 bear jq - sudo pip3 install sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe gersemi mbake ruff sarif-tools - sudo pip3 install git+https://github.com/antmicro/astsee.git + python3 -m venv --system-site-packages ~/.verilator_pyenv + source ~/.verilator_pyenv/bin/activate + pip3 install sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe gersemi mbake ruff + pip3 install git+https://github.com/antmicro/astsee.git + pipx install sarif-tools cpan install Pod::Perldoc + # + # Later, when building or testing Verilator, you will need + source ~/.verilator_pyenv/bin/activate Install SystemC