IntenseWebs/pgadmin4
3
0
Fork 0
mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2024-11-24 17:50:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Aditya Toshniwal 2022-12-19 10:45:45 +05:30 committed by GitHub
parent 45aa274a9e
commit cbea043ca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/check-doc-build.yml vendored
View File

@ -32,5 +32,8 @@ jobs:
- name: Install sphinx - name: Install sphinx
run: pip install sphinx run: pip install sphinx
- name: Install sphinx youtube
run: pip install sphinxcontrib-youtube
- name: Check the documentation - name: Check the documentation
run: make docs run: make docs

1
Make.bat
View File

@ -247,6 +247,7 @@ REM Main build sequence Ends
ECHO Building docs... ECHO Building docs...
CALL pip install sphinx || EXIT /B 1 CALL pip install sphinx || EXIT /B 1
CALL pip install sphinxcontrib-youtube || EXIT /B 1
MKDIR "%BUILDROOT%\docs\en_US\html" MKDIR "%BUILDROOT%\docs\en_US\html"
CD "%WD%\docs\en_US" CD "%WD%\docs\en_US"
CALL "%TMPDIR%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1 CALL "%TMPDIR%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1

1
README.md
View File

@ -206,6 +206,7 @@ virtual environment. This can be installed with the pip package manager:
```bash ```bash
$ source venv/bin/activate $ source venv/bin/activate
(venv) $ pip install Sphinx (venv) $ pip install Sphinx
(venv) $ pip install sphinxcontrib-youtube
``` ```
The docs can then be built using the Makefile in *$PGADMIN4_SRC*, e.g. The docs can then be built using the Makefile in *$PGADMIN4_SRC*, e.g.

2
docs/en_US/conf.py
View File

@ -36,7 +36,7 @@ import config
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

8
docs/en_US/processes.rst
View File

@ -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 . .. 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

1
pkg/win32/README.md
View File

@ -155,6 +155,7 @@ want to build an installer.
python -m venv venv python -m venv venv
pip install -r web\regression\requirements.txt pip install -r web\regression\requirements.txt
pip install sphinx pip install sphinx
pip install sphinxcontrib-youtube
You should now be able to run the pgAdmin Python application, or build the You should now be able to run the pgAdmin Python application, or build the
desktop runtime. desktop runtime.