Skip to content

Commit cf8dd0c

Browse files
Update doc/README.md for better package management
Previous doc/README told users to install sphinx globally using the distribution's package manager. This commit changes that to only tell users to use pip and optionally make a python virtual environment.
1 parent e62e8ff commit cf8dd0c

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

doc/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
#Sphinx
22
_build
3+
.venv

doc/README

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,22 @@ Currently VTR's documenation is automatically built by https://readthedocs.org/p
1414
How to build documentation
1515
--------------------------
1616

17-
To build the documentation locally you need sphinx installed:
17+
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:
1818

19-
For ubuntu/debian based systems:
19+
$ sudo apt install doxygen
2020

21-
$ apt-get install python-sphinx
21+
While Fedora and RHEL users can use the following command:
2222

23-
To properly build citations and the bibliography, we use the sphinxcontrib-bibtex extension:
23+
$ sudo dnf install doxygen
2424

25-
$ pip install sphinxcontrib-bibtex
25+
You can install python dependencies by fist optionally making a virtual environment:
2626

27-
To install all the python requirements:
27+
$ python -m venv .venv
28+
$ source .venv/bin/activate
2829

29-
$ pip install -r requirements.txt
30+
And then using the requirements file to install the dependencies:
31+
32+
$ pip install -r requirements.txt
3033

3134
To build the documentation just run:
3235

0 commit comments

Comments
 (0)