Explorar el Código

doc: use a venv for python deps

skoupidi hace 1 año
padre
commit
0eb4049575
Se han modificado 3 ficheros con 14 adiciones y 0 borrados
  1. 1 0
      doc/.gitignore
  2. 12 0
      doc/README.md
  3. 1 0
      doc/requirements.txt

+ 1 - 0
doc/.gitignore

@@ -1,3 +1,4 @@
+/venv
 book/*
 src/clients/cashierd_jsonrpc.md
 src/clients/darkfid_jsonrpc.md

+ 12 - 0
doc/README.md

@@ -7,6 +7,18 @@ https://darkrenaissance.github.io/darkfi
 When adding or removing a section of the book, make sure to update the
 [SUMMARY.md](src/SUMMARY.md) file to actually list the contents.
 
+Use a python virtual environment to install its requirements:
+```shell
+% python -m venv venv
+% source venv/bin/activate
+```
+
+Then install the requirements:
+
+```shell
+% pip install -r requirements.txt
+```
+
 For the mdbook-katex backend run:
 
 ```

+ 1 - 0
doc/requirements.txt

@@ -0,0 +1 @@
+prettytable