Publish nightly version of the documentation

Signed-off-by: Przemek Tredak <ptredak@nvidia.com>

.github/workflows/build_docs.yml

@@ -7,6 +7,7 @@ name: 'Build documentation'
 on:
   pull_request:
   workflow_dispatch:
+  workflow_call:
 jobs:
   build_docs:
     runs-on: ubuntu-latest

.github/workflows/deploy_nightly_docs.yml

+# Copyright (c) 2022-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+#
+# See LICENSE for license information.
+
+# A workflow to deploy the nightly version of TE documentation to GitHub Pages
+name: Deploy nightly docs
+on:
+  push:
+    branches: [ "main" ]
+jobs:
+  build:
+    uses: ./.github/workflows/build_docs.yml
+
+  prepare:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+            name: "te_docs"
+            path: "html"
+      - name: Prepare for pages
+        uses: actions/upload-pages-artifact@v1.0.7
+        with:
+          path: "html"
+  deploy:
+    needs: prepare
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+    - name: Deploy
+      uses: actions/deploy-pages@v2.0.0

docs/conf.py

@@ -64,6 +64,7 @@ extensions = [
         'sphinx.ext.autodoc',
         'sphinx.ext.mathjax',
         'sphinx.ext.napoleon',
+        'sphinx.ext.ifconfig',
         'nbsphinx',
         'breathe',
         'autoapi.extension']

docs/index.rst

@@ -6,6 +6,15 @@
 Transformer Engine documentation
 ==============================================
 
+.. ifconfig:: "dev" in release
+
+   .. warning::
+      You are currently viewing unstable developer preview of the documentation.
+      To see the documentation for the latest stable release, refer to:
+
+      * `Release Notes <https://docs.nvidia.com/deeplearning/transformer-engine/release-notes/index.html>`_
+      * `Developer Guide <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/index.html>`_ (stable version of this page)
+
 .. include:: ../README.rst
    :start-after: overview-begin-marker-do-not-remove
    :end-before: overview-end-marker-do-not-remove