Skip to content

Commit d33cda1

Browse files
authored
[duguids] SG-29350 adding video to installation doc (#271)
* SG-29350 adding video to installation doc * attempting embed with html and hyperlinking * update with Norberto's research * another attempt at the hyperlink * following tutorial hyperlink instructions Co-authored-by: Shayna Duguid <shayna.duguid@autodesk.com>
1 parent 62d2bb7 commit d33cda1

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ Because the needs of every studio can prove to be very different, we don't inclu
1818
decisions to you. The API is powerful enough you can write your own "smarts" in a wrapper on top
1919
of the Shotgun API.
2020

21+
.. _pythonoverviewvideo:
22+
23+
Overview Video of Setting Up Your Environment with the Python API
24+
=================================================================
25+
26+
.. raw:: html
27+
28+
<iframe width="560" height="315" src="https://www.youtube.com/embed/RYEBQDJiXAs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
29+
2130
In addition to basic metadata, the API contains methods for managing media including thumbnails,
2231
filmstrip thumbnails, images, uploaded, and both locally and remotely linked media like
2332
Quicktimes, etc.

docs/installation.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Minimum Requirements
1818
your version of Shotgun will raise an appropriate exception. In general, we attempt to
1919
document these where possible.
2020

21-
2221
******************************
2322
Installing into ``PYTHONPATH``
2423
******************************
@@ -29,6 +28,9 @@ You'll need to save it somewhere your local Python installation can find it.
2928
.. seealso:: For more information on ``PYTHONPATH`` and using modules in Python, see
3029
http://docs.python.org/tutorial/modules.html
3130

31+
.. note::
32+
:ref:`Visit the introduction to the Python API <pythonoverviewvideo>` to see an overview video of Setting Up Your Environment with the Python API.
33+
3234
***********************
3335
Installing with ``pip``
3436
***********************

0 commit comments

Comments
 (0)