From cbea043ca16a300a7cd8d0e27fe274720f040eb2 Mon Sep 17 00:00:00 2001
From: Aditya Toshniwal <aditya.toshniwal@enterprisedb.com>
Date: Mon, 19 Dec 2022 10:45:45 +0530
Subject: [PATCH] Allow YouTube video demo links to be added to appropriate
 pgAdmin documentation. #5563

---
 .github/workflows/check-doc-build.yml | 3 +++
 Make.bat                              | 1 +
 README.md                             | 1 +
 docs/en_US/conf.py                    | 2 +-
 docs/en_US/processes.rst              | 8 +++++++-
 pkg/win32/README.md                   | 1 +
 6 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/check-doc-build.yml b/.github/workflows/check-doc-build.yml
index ac1a08aa5..19099ca3d 100644
--- a/.github/workflows/check-doc-build.yml
+++ b/.github/workflows/check-doc-build.yml
@@ -32,5 +32,8 @@ jobs:
       - name: Install sphinx
         run: pip install sphinx
 
+      - name: Install sphinx youtube
+        run: pip install sphinxcontrib-youtube
+
       - name: Check the documentation
         run: make docs
diff --git a/Make.bat b/Make.bat
index 3822cfd9f..48cef8949 100644
--- a/Make.bat
+++ b/Make.bat
@@ -247,6 +247,7 @@ REM Main build sequence Ends
 
     ECHO Building docs...
     CALL pip install sphinx || EXIT /B 1
+    CALL pip install sphinxcontrib-youtube || EXIT /B 1
     MKDIR "%BUILDROOT%\docs\en_US\html"
     CD "%WD%\docs\en_US"
     CALL "%TMPDIR%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1
diff --git a/README.md b/README.md
index 996cf43c4..601fadcb6 100644
--- a/README.md
+++ b/README.md
@@ -206,6 +206,7 @@ virtual environment. This can be installed with the pip package manager:
 ```bash
 $ source venv/bin/activate
 (venv) $ pip install Sphinx
+(venv) $ pip install sphinxcontrib-youtube
 ```
 
 The docs can then be built using the Makefile in *$PGADMIN4_SRC*, e.g.
diff --git a/docs/en_US/conf.py b/docs/en_US/conf.py
index 256c62a73..b52516277 100644
--- a/docs/en_US/conf.py
+++ b/docs/en_US/conf.py
@@ -36,7 +36,7 @@ import config
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ["sphinxcontrib.youtube"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
diff --git a/docs/en_US/processes.rst b/docs/en_US/processes.rst
index 8baf5925a..f363605b9 100644
--- a/docs/en_US/processes.rst
+++ b/docs/en_US/processes.rst
@@ -46,4 +46,10 @@ Use the **Stop Process** button to stop the Backup process.
 
 .. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
 
-.. |sm_icon| image:: images/sm_icon.png
\ No newline at end of file
+.. |sm_icon| image:: images/sm_icon.png
+
+Watch the demo
+*********************
+.. youtube:: jjP6O_xuHxE
+    :align: center
+    :width: 800
\ No newline at end of file
diff --git a/pkg/win32/README.md b/pkg/win32/README.md
index c1ecc048f..f3fa0f990 100644
--- a/pkg/win32/README.md
+++ b/pkg/win32/README.md
@@ -155,6 +155,7 @@ want to build an installer.
         python -m venv venv
         pip install -r web\regression\requirements.txt
         pip install sphinx
+        pip install sphinxcontrib-youtube
 
 You should now be able to run the pgAdmin Python application, or build the
 desktop runtime.