docs: Rebuild on push (#1765)

Also clarify the steps for building docs locally. Co-authored-by: Oliver Holworthy <[email protected]>
NVIDIA-Merlin · Feb 20, 2023 · 08c3c4e · 08c3c4e
1 parent 3ae3427
commit 08c3c4e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.github/workflows/docs-sched-rebuild.yaml b/.github/workflows/docs-sched-rebuild.yaml
@@ -1,9 +1,9 @@
 name: docs-sched-rebuild
 
 on:
-  schedule:
-    # * is a special character in YAML so you have to quote this string
-    - cron: "0 0 * * *"
+  branches: [main]
+  tags:
+    - v*
   workflow_dispatch:
 
 jobs:

diff --git a/docs/README.md b/docs/README.md
@@ -14,6 +14,7 @@ Follow the instructions below to build the docs.
    ```shell
    python3 -m vevn .venv
    source .venv/bin/activate
+   python -m pip install -U pip tox
    tox -e docs
    ```