[CONTRIBUTING] Update instructions for how to build PDF files locally#319
[CONTRIBUTING] Update instructions for how to build PDF files locally#319stuij merged 1 commit intoARM-software:mainfrom
Conversation
smithp35
left a comment
smithp35
left a comment
There was a problem hiding this comment.
Thanks for adding the instructions. I've made one suggestion that might simplify the text, but its not that important if you prefer the original.
CONTRIBUTING.md
Outdated
| To check the outcome of your changes, use the `tools/rst2pdf/generate-pdfs.sh` | ||
| script. To install the (python) prerequisites for the script, do the following. | ||
|
|
||
| Create and activate Python virtual environment (you will need to use Python 3.x): |
There was a problem hiding this comment.
We might be able to get rid of the (you will need to use Python 3.x) if we use python3 and pip3 explicitly.
There was a problem hiding this comment.
I prefer to use a more generic commands like python in the code listings, but I'm happy to change it to python3 and remove notice about having to use Python 3.x to make it more concise.
yury-khrustalev
force-pushed
the
patch/contrib
branch
from
b344a00 to
dab52a3
Compare
Add instructions for how to build PDF files locally using Python virtual environment. Also add a .gitignore file.
yury-khrustalev
force-pushed
the
patch/contrib
branch
from
dab52a3 to
1369c8e
Compare
smithp35
left a comment
smithp35
left a comment
There was a problem hiding this comment.
LGTM. I'll leave some time for others to comment. Give me a ping next week and I can merge it for you (apologies merge is somewhat locked down in this repo).
3 participants
Add instructions for how to build PDF files locally using Python virtual environment.
Also add a
.gitignorefile.