Skip to content

Commit 0f269f2

Browse files
committed
Update README to use venv / pip for local work
1 parent d6e8aa7 commit 0f269f2

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,15 @@ For your first contribution, our CLA bot will ask you to sign the Contributor Li
2626
Working locally
2727
===============
2828

29-
First, install the required packages (these are the Ubuntu packages):
29+
First, install the required packages (needs Python3 with venv support):
3030

31-
apt install python3-sphinx python3-sphinx-rtd-theme
32-
33-
Also install the Youtube extension for sphinx:
34-
35-
pip install sphinxcontrib-youtube
31+
python3 -mvenv .venv
32+
source .venv/bin/activate
33+
pip install -r requirements.txt
3634

3735
Then clone the repository and do your changes. To compile:
3836

39-
sphinx-build . _build
37+
make html
4038

4139
Then you can see your compiled version in the `_build` directory.
4240

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1+
sphinx
12
sphinx_rtd_theme
23
sphinxcontrib-youtube

0 commit comments

Comments
 (0)