Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[duguids] SG-29350 adding video to installation doc #271

Merged
merged 5 commits into from
Dec 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ Because the needs of every studio can prove to be very different, we don't inclu
decisions to you. The API is powerful enough you can write your own "smarts" in a wrapper on top
of the Shotgun API.

.. _pythonoverviewvideo:

Overview Video of Setting Up Your Environment with the Python API
=================================================================

.. raw:: html

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

In addition to basic metadata, the API contains methods for managing media including thumbnails,
filmstrip thumbnails, images, uploaded, and both locally and remotely linked media like
Quicktimes, etc.
Expand Down
4 changes: 3 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Minimum Requirements
your version of Shotgun will raise an appropriate exception. In general, we attempt to
document these where possible.


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

.. note::
:ref:`Visit the introduction to the Python API <pythonoverviewvideo>` to see an overview video of Setting Up Your Environment with the Python API.

***********************
Installing with ``pip``
***********************
Expand Down