You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Paco Hope a694c2a654 Added new pages and linked in 10 months ago
source Added new pages and linked in 10 months ago
Makefile Adding documentation 10 months ago Forgot to put "source" 10 months ago
requirements.txt Updated styles and theme options 10 months ago Adding documentation 10 months ago

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.

  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 to upload it to the S3 bucket (only works if you have the right profile/permissions in AWS)


I recommend building a Python venv.


  1. Make the virtual environment python3 -m venv .venv
  2. Activate it:
  • Windows: .venv\Scripts\activate
  • Other: source .venv/bin/activate
  1. Install all the requirements into it:
    1. pip install -r requirements.txt
    2. pip3 install -e .

Now you can run the steps above in the Building section.