Allow YouTube video demo links to be added to appropriate pgAdmin documentation. #5563

.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

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

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.

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']

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
+.. |sm_icon| image:: images/sm_icon.png
+
+Watch the demo
+*********************
+.. youtube:: jjP6O_xuHxE
+    :align: center
+    :width: 800

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.