Skip to content

Commit 4fd6aec

Browse files
[CONTRIBUTING] Update instructions for how to build PDF files locally (#319)
Add instructions for how to build PDF files locally using Python virtual environment. Also add a `.gitignore` file.
1 parent c51addc commit 4fd6aec

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
venv
2+
build

CONTRIBUTING.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,26 @@ withdrawn it will be moved to an archive folder.
8080

8181
## Manual checking of the PDF documents and Continuous Integration
8282

83-
To check the outcome of your changes, run the `tools/rst2pdf/generate-pdfs.sh`
84-
script. To install the (python) prerequisites for the script, run the
85-
`tools/rst2pdf/install.sh` script.
83+
To check the outcome of your changes, use the `tools/rst2pdf/generate-pdfs.sh`
84+
script. To install the (python) prerequisites for the script, do the following.
85+
86+
Create and activate Python virtual environment:
87+
88+
```
89+
python3 -m venv ./venv
90+
source ./venv/bin/activate
91+
pip3 install -U pip setuptools wheel
92+
```
93+
94+
Run the `tools/rst2pdf/install.sh` script.
95+
96+
Now run the `tools/rst2pdf/generate-pdfs.sh`:
97+
98+
```
99+
./tools/rst2pdf/generate-pdfs.sh build
100+
```
101+
102+
The generated PDF files will be in the `build` directory.
86103

87104
You can also check the rst syntax of the documents you changed with the
88105
`tools/common/check-rst-syntax.sh` script.

0 commit comments

Comments
 (0)