Update documentation to generate site. (#3196)

Signed-off-by: Nelson Araujo <[email protected]>

Author: nelsonjr

Diff for: flytekit/core/data_persistence.py

@@ -412,7 +412,7 @@ async def async_put_raw_data(
         If lpath is a streamable, then it can only be a single file.
 
         Writes to:
-            <raw output prefix>/<upload_prefix>/<file_name>
+            {raw output prefix}/{upload_prefix}/{file_name}
 
         :param lpath: A file-like object or a string path
         :param upload_prefix: A prefix to add to the path, see above for usage, can be an "". If None then a random

Diff for: flytekit/core/type_engine.py

@@ -75,10 +75,12 @@ class BatchSize:
     """
     This is used to annotate a FlyteDirectory when we want to download/upload the contents of the directory in batches. For example,
 
+    ```python
     @task
     def t1(directory: Annotated[FlyteDirectory, BatchSize(10)]) -> Annotated[FlyteDirectory, BatchSize(100)]:
         ...
         return FlyteDirectory(...)
+    ```
 
     In the above example flytekit will download all files from the input `directory` in chunks of 10, i.e. first it
     downloads 10 files, loads them to memory, then writes those 10 to local disk, then it loads the next 10, so on