SG-31044 Add default_storage_root hook in the list of core hooks (#924)

* Add default_storage_root hook in the list of core hooks * Fix RST syntax * Add link to the example folder
shotgunsoftware · Sep 21, 2023 · 6766e56 · 6766e56
1 parent dc934d4
commit 6766e56
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/core.rst b/docs/core.rst
@@ -168,6 +168,13 @@ context_change.py
 .. autoclass:: context_change.ContextChange
     :members:
 
+default_storage_root.py
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: default_storage_root
+.. autoclass:: default_storage_root.DefaultStorageRoot
+    :members:
+
 engine_init.py
 ~~~~~~~~~~~~~~
 

diff --git a/hooks/default_storage_root.py b/hooks/default_storage_root.py
@@ -25,9 +25,9 @@ def execute(self, storage_roots, project_id=None, metadata=None):
         Toolkit initialization.
 
         You can find example implementations in the
-        tests/core_tests/test_default_storage_root_hook folder which
-        allow you to switch between storages if you have a different
-        storage root per project.
+        `tests/core_tests/test_default_storage_root_hook <https://github.com/shotgunsoftware/tk-core/tree/master/tests/core_tests/test_default_storage_root_hook>`_
+        folder which allow you to switch between storages if you have a
+        different storage root per project.
 
         The default implementation does nothing.