From 1b7df6e3b2d15021187882c1299762a43006a129 Mon Sep 17 00:00:00 2001 From: Paco Hope Date: Thu, 11 Aug 2022 13:45:22 -0400 Subject: [PATCH] Added prerequisites --- docs/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 239026f..469528e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,24 @@ # Building Documentation +This is the documentation that appears on [The tfscript website](https://tfscript.nickhope.world/). + +## Building the Docs + +Before you can build the docs, you have to do the _Prerequisites_ below. + 1. Run `make html` 2. The docs appear in `docs/build/html`. You can open them in a browser (e.g., on Mac do `open docs/build/html/index.html`) -3. Run `sync.sh` to upload it to the S3 bucket +3. Run `sync.sh` to upload it to the S3 bucket (only works if you have the right profile/permissions in AWS) + +## Prerequisites + +I recommend building a Python [**venv**](https://docs.python.org/3/library/venv.html). + +1. Make the virtual environment `python -m venv ~/.python` +2. Activate it: `source ~/.python/bin/activate` +3. Install all the requirements into it. + 1. `pip3 install -r ../requirements.txt` + 2. `pip3 install -r requirements.txt` + +Now you can run the steps above in the **Building** section. +