From 346fa20e5e5c9369d0b2039eec0916cf7410ae1b Mon Sep 17 00:00:00 2001 From: Carlos Villavicencio Date: Thu, 15 May 2025 10:45:19 -0500 Subject: [PATCH 1/3] Fix more RSTs files for Sphinx --- docs/cookbook/examples/basic_create_shot.rst | 4 ++-- docs/cookbook/examples/basic_delete_shot.rst | 4 ++-- docs/cookbook/examples/basic_find_shot.rst | 4 ++-- docs/cookbook/examples/basic_update_shot.rst | 4 ++-- docs/cookbook/tasks/split_tasks.rst | 4 ++-- docs/cookbook/tasks/updating_tasks.rst | 6 +++--- docs/reference.rst | 1 - 7 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/cookbook/examples/basic_create_shot.rst b/docs/cookbook/examples/basic_create_shot.rst index 7513305fa..f7d412f89 100644 --- a/docs/cookbook/examples/basic_create_shot.rst +++ b/docs/cookbook/examples/basic_create_shot.rst @@ -51,8 +51,8 @@ this dictionary represents. It does not correspond to any field in Flow Producti Flow Production Tracking will *always* return the ``id`` and ``type`` keys in the dictionary when there are results representing an entity. -The Complete Example --------------------- +The Complete Example for creating a Shot +---------------------------------------- :: #!/usr/bin/env python diff --git a/docs/cookbook/examples/basic_delete_shot.rst b/docs/cookbook/examples/basic_delete_shot.rst index c79215e25..886b962d3 100644 --- a/docs/cookbook/examples/basic_delete_shot.rst +++ b/docs/cookbook/examples/basic_delete_shot.rst @@ -13,8 +13,8 @@ If the Shot was deleted successfully ``result`` will contain:: True -The Complete Example --------------------- +The Complete Example for deleting a Shot +---------------------------------------- :: #!/usr/bin/env python diff --git a/docs/cookbook/examples/basic_find_shot.rst b/docs/cookbook/examples/basic_find_shot.rst index 945eb1be6..4f5d73934 100644 --- a/docs/cookbook/examples/basic_find_shot.rst +++ b/docs/cookbook/examples/basic_find_shot.rst @@ -37,8 +37,8 @@ easier to read. So we'll add that to the import section of our script.:: import shotgun_api3 from pprint import pprint # useful for debugging -The Complete Example --------------------- +The Complete Example for finding a Shot +--------------------------------------- :: #!/usr/bin/env python diff --git a/docs/cookbook/examples/basic_update_shot.rst b/docs/cookbook/examples/basic_update_shot.rst index c2413c3ee..4e2055d49 100644 --- a/docs/cookbook/examples/basic_update_shot.rst +++ b/docs/cookbook/examples/basic_update_shot.rst @@ -40,8 +40,8 @@ It does not correspond to any field in Flow Production Tracking. Flow Production Tracking will *always* return the ``id`` and ``type`` keys in the dictionary when there are results representing an entity. -The Complete Example --------------------- +The Complete Example for updating a Shot +---------------------------------------- :: #!/usr/bin/env python diff --git a/docs/cookbook/tasks/split_tasks.rst b/docs/cookbook/tasks/split_tasks.rst index d16c50e94..96f639037 100644 --- a/docs/cookbook/tasks/split_tasks.rst +++ b/docs/cookbook/tasks/split_tasks.rst @@ -62,8 +62,8 @@ How Do Splits Influence Dates And Dates Influence Splits - In the case of a shorter duration splits, starting with the latest ones, will be either removed or shortened until the new duration is met. -Examples -======== +Examples for splitting Tasks +============================ Throughout the following examples, each successive one will build on the previous. start_date, due_date and duration being ignored diff --git a/docs/cookbook/tasks/updating_tasks.rst b/docs/cookbook/tasks/updating_tasks.rst index c7c216e3f..db2433e79 100644 --- a/docs/cookbook/tasks/updating_tasks.rst +++ b/docs/cookbook/tasks/updating_tasks.rst @@ -32,9 +32,9 @@ General Rules first, then ``due_date`` (otherwise setting ``duration`` will change ``due_date`` after it is set). -******** -Examples -******** +*************************** +Examples for updating Tasks +*************************** The following examples show what the resulting Task object will look like after being run on the initial Task object listed under the header of each section. diff --git a/docs/reference.rst b/docs/reference.rst index 77241f052..5f3888a52 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -42,7 +42,6 @@ The documentation for all of the methods you'll need in your scripts lives in he Shotgun.close Shotgun.authenticate_human_user Shotgun.get_session_token - Shotgun.set_up_auth_cookie Shotgun.add_user_agent Shotgun.reset_user_agent Shotgun.set_session_uuid From 99f4387335ff3bf2e060f02aab9a45b2e3214b86 Mon Sep 17 00:00:00 2001 From: Carlos Villavicencio Date: Thu, 15 May 2025 10:51:11 -0500 Subject: [PATCH 2/3] Update ref --- docs/authentication.rst | 2 ++ docs/cookbook/examples/svn_integration.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/authentication.rst b/docs/authentication.rst index ea049fbd0..9206464f3 100644 --- a/docs/authentication.rst +++ b/docs/authentication.rst @@ -1,3 +1,5 @@ +.. _authentication: + ############## Authentication ############## diff --git a/docs/cookbook/examples/svn_integration.rst b/docs/cookbook/examples/svn_integration.rst index 8b0a6ce46..c676fd8ea 100644 --- a/docs/cookbook/examples/svn_integration.rst +++ b/docs/cookbook/examples/svn_integration.rst @@ -130,7 +130,7 @@ Explanation of selected lines: - line ``14``: This should be the URL to your instance of Flow Production Tracking. - lines ``15-16``: Make sure you get these values from the "Scripts" page in the Admin section of - the Flow Production Tracking web application. If you're not sure how to do this, check out :doc:`authentication`. + the Flow Production Tracking web application. If you're not sure how to do this, check out :ref:`authentication`. - line ``17``: This is the address of Trac, our web-based interface that we use with Subversion. You may use a different interface, or none at all, so feel free to adjust this line or ignore it as your case may be. From 83527b6f8b12e723a7b1acdf282578d2e552f8be Mon Sep 17 00:00:00 2001 From: Carlos Villavicencio Date: Thu, 15 May 2025 10:53:00 -0500 Subject: [PATCH 3/3] Remove duplicate label --- docs/authentication.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/authentication.rst b/docs/authentication.rst index 9206464f3..ea049fbd0 100644 --- a/docs/authentication.rst +++ b/docs/authentication.rst @@ -1,5 +1,3 @@ -.. _authentication: - ############## Authentication ##############