tfscript
/
tfscript
2
0
Fork 0
Code Issues 5 Pull Requests Projects 1 Releases Wiki Activity

Added prerequisites

pull/11/head
Paco Hope 2022-08-11 13:45:22 -04:00
parent 59e42debcb
commit 1b7df6e3b2
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/README.md
View File

@ -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.