From f25779d10ac30c3a9a62ccb6dc4042039ff9d617 Mon Sep 17 00:00:00 2001 From: Tomoya Fujita Date: Sun, 22 Sep 2024 18:20:13 -0700 Subject: [PATCH] add venv to the official doc build procedure. Signed-off-by: Tomoya Fujita --- .../Contributing-To-ROS-2-Documentation.rst | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst index 9397a3dc57..d551e85ac2 100644 --- a/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst +++ b/source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst @@ -33,33 +33,37 @@ The root directory contains configuration and files required to locally build th Building the site locally ------------------------- -Start by installing requirements located in the ``requirements.txt`` file: +Start by creating `venv `__ to build the documentation: + +.. code-block:: console + + # activate the venv + python3 -m venv ros2doc + + # activate venv + source ros2doc/bin/activate + +And install requirements located in the ``requirements.txt`` file: .. tabs:: .. group-tab:: Linux - The next command does a user-specific install, which requires ``~/.local/bin/`` to be added to ``$PATH``: - .. code-block:: console - pip3 install --user --upgrade -r requirements.txt + pip install -r requirements.txt -c constraints.txt .. group-tab:: macOS .. code-block:: console - pip3 install --user --upgrade -r requirements.txt + pip install -r requirements.txt -c constraints.txt .. group-tab:: Windows .. code-block:: console - python -m pip install --user --upgrade -r requirements.txt - -.. note:: - - It is recommended to use `virtualenv `__ to build, otherwise you might need to add ``--break-system-packages`` option with ``pip install`` because of `PEP 668 `__. + python -m pip install -r requirements.txt -c constraints.txt In order for Sphinx to be able to generate diagrams, the ``dot`` command must be available.