Paco Hope 1b7df6e3b2 | ||
---|---|---|
.. | ||
source | ||
Makefile | ||
README.md | ||
requirements.txt | ||
sync.sh |
README.md
Building Documentation
This is the documentation that appears on The tfscript website.
Building the Docs
Before you can build the docs, you have to do the Prerequisites below.
- Run
make html
- The docs appear in
docs/build/html
. You can open them in a browser (e.g., on Mac doopen docs/build/html/index.html
) - 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.
- Make the virtual environment
python -m venv ~/.python
- Activate it:
source ~/.python/bin/activate
- Install all the requirements into it.
pip3 install -r ../requirements.txt
pip3 install -r requirements.txt
Now you can run the steps above in the Building section.