aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-09-20 20:30:54 -0700
committerMicah Lee <micah@micahflee.com>2020-09-20 20:30:54 -0700
commit841ad59171300913d0c5281eb4f61ff841f4c346 (patch)
treea56a67019dde35b66414a5d494358f0e9406e0f9 /docs/README.md
parent9783667308a3a8c5aad4e2c59fb4e4c7c6621d36 (diff)
downloadonionshare-841ad59171300913d0c5281eb4f61ff841f4c346.tar.gz
onionshare-841ad59171300913d0c5281eb4f61ff841f4c346.zip
Migrate docs dependencies from requirements.txt to poetry
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md
index fd444384..fe026802 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -5,13 +5,13 @@ All these commands must be run from the `docs` folder.
You must have the python dependencies installed to build the docs:
```sh
-pip3 install --user -r requirements.txt
+poetry install
```
To build HTML docs:
```sh
-make html
+poetry run make html
```
Then open `docs/build/html/index.html` in a browser to see it.
@@ -19,7 +19,7 @@ Then open `docs/build/html/index.html` in a browser to see it.
To update all of the translations and build all the html, run:
```sh
-./build.sh
+poetry run ./build.sh
```
You will end up with the documentation in all supported locales in `docs/localized_html`.