SG-40980 Tests

.pre-commit-config.yaml

@@ -47,3 +47,9 @@ repos:
     rev: 25.1.0
     hooks:
     - id: black
+
+### does not work .... lots of errors
+#  - repo: https://github.com/pycqa/flake8
+#    rev: 7.3.0#
+#    hooks:
+#    - id: flake8

azure-pipelines-templates/build_documentation.yml

@@ -0,0 +1,44 @@
+# Copyright (c) 2025 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+
+parameters:
+  # Git ref of tk-toolchain to use.
+  tk_toolchain_ref: ticket/SG-40980-docs-warning-on-error-always
+  # Git ref of tk-core to use.
+  tk_core_ref: master
+
+
+jobs:
+- job: build_documentation
+  displayName: Build Sphinx Documentation
+  pool:
+    vmImage: ubuntu-latest
+
+  steps:
+  - task: UsePythonVersion@0
+    displayName: Use Python 3.10
+    inputs:
+      versionSpec: "3.10"
+
+  - task: Bash@3
+    displayName: Install Python dependencies
+    inputs:
+      targetType: inline
+      script: |
+        pip install --upgrade pip
+        pip install --upgrade setuptools wheel
+        pip install --upgrade \
+          https://github.com/shotgunsoftware/tk-toolchain/archive/${{ parameters.tk_toolchain_ref }}.zip
+
+  - task: Bash@3
+    displayName: Build Shpinx Documentation
+    inputs:
+      targetType: inline
+      script: tk-docs-preview --build-only --verbose

azure-pipelines-templates/code_style_validation.yml

@@ -29,22 +29,31 @@ jobs:
 - job: code_style_validation
   displayName: Code Style Validation
   pool:
-    vmImage: 'ubuntu-latest'
+    vmImage: ubuntu-latest
 
   steps:
   - task: UsePythonVersion@0
+    displayName: Use Python 3.10
     inputs:
       versionSpec: 3.10
-      addToPath: True
-      architecture: 'x64'
 
-  - script: |
-      pip install --upgrade pip setuptools wheel
-      pip install --upgrade pre-commit
-    displayName: Install dependencies
+  - task: Bash@3
+    displayName: Install Python dependencies
+    inputs:
+      targetType: inline
+      script: |
+        pip install --upgrade pip
+        pip install --upgrade setuptools wheel
+        pip install --upgrade pre-commit
 
-  - bash: pre-commit autoupdate
+  - task: Bash@3
     displayName: Update pre-commit hook versions
+    inputs:
+      targetType: inline
+      script: pre-commit autoupdate
 
-  - bash: pre-commit run --all
-    displayName: Validate code with pre-commit
+  - task: Bash@3
+    displayName: Validate code
+    inputs:
+      targetType: inline
+      script: pre-commit run --all

azure-pipelines.yml

@@ -53,6 +53,7 @@ pr:
 jobs:
 - template: azure-pipelines-templates/code_style_validation.yml
 - template: azure-pipelines-templates/type_checking.yml
+- template: azure-pipelines-templates/build_documentation.yml
 
 # These are jobs templates, they allow to reduce the redundancy between
 # variations of the same build. We pass in the image name

shotgun_api3/shotgun.py

@@ -1898,6 +1898,7 @@ def export_page(self, page_id, format, layout_name=None):
             "ID,Name,Status\\n1,Shot 001,ip\\n2,    Shot 002,rev\\n"
             >>> sg.export_page(12345, "csv")
             "ID,Name,Status\\n1,Shot 001,ip\\n2,Shot 002,rev\\n"
+
         :param int page_id: The ID of the page to export.
         :param str format: The format to export the page to. Supported format is ``"csv"``.
         :param str layout_name: Optional layout name. This should be the name of the layout seen in the Flow Production Tracking UI.