Skip to content

Commit 95ad2d9

Browse files
committed
Fix documentation
Signed-off-by: Jeff Goeders <[email protected]>
1 parent 9887cb6 commit 95ad2d9

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

BUILDING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,28 +59,26 @@ The following should be enough to get the tools, VPR GUI and tests going on a mo
5959
./install_apt_packages.sh
6060
```
6161

62-
You will also need several Python packages. It is best to do this within a Python virtual environment:
63-
64-
```
62+
You will also need several Python packages. You can optionally install and activate a Python virtual environment so that you do not need to modify your system Python installation:
63+
```shell
6564
make env
65+
source .venv/bin/activate
6666
```
6767

68-
Anytime you run the VTR flow or regressions tests (which use Python) you should activate the virtual environment in your terminal:
68+
Then to install the Python packages:
6969

70+
```shell
71+
pip install -r requirements.txt
7072
```
71-
source .venv/bin/activate
72-
```
7373

74-
For documentation generation these additional packages are required:
74+
*NOTE: Anytime you run the VTR flow or regressions tests (which use Python) you should activate the virtual environment in your terminal.*
75+
76+
For documentation generation these additional Python packages are required:
7577

7678
```shell
77-
apt-get install \
78-
doxygen \
79-
sphinx-common
8079
pip install -r doc/requirements.txt
8180
```
8281

83-
8482
For development the following additional packages are useful:
8583

8684
```shell

doc/src/quickstart/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ Then, to install the required Python packages within a new virtual environment:
2828
.. code-block:: bash
2929
3030
> make env
31+
> source .venv/bin/activate
32+
> pip install -r requirements.txt
3133
32-
This will create a Python virtual environment in ``.venv``; however, you won't need this environment until later in the tutorial when you reach the section on "Automatically Running the VTR Flow".
3334
3435
Build VTR
3536
---------

doc/src/vtr/install_vtr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Install VTR
1414
The complete VTR flow has been tested on 64-bit Linux systems.
1515
The flow should work in other platforms (32-bit Linux, Windows with cygwin) but this is untested.
1616

17-
.. seealso:: More information about building VTR can be found in the :ref:`developer_guide`
17+
.. seealso:: Full information about building VTR, including setting up required system packages and Python packages, can be found in the :ref:`Building VTR guide <building_vtr>`.
1818

1919
Please :ref:`let us know <contact>` your experience with building VTR so that we can improve the experience for others.
2020

0 commit comments

Comments
 (0)