Merge pull request #43 from Safe/eng-83682-update-docstring-links

Update BaseTransformer Links in Docstrings
safesoftware · Nov 19, 2024 · e890bbe · e890bbe
2 parents 060ff0c + ef69671
commit e890bbe
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,10 @@
 # fmetools changes
 
+## 0.10.3
+
+* Updated docstring references to `fmetools._deprecated.FMEBaseTransformer.*` to link to new `fme.BaseTransformer` documentation.
+
+
 ## 0.10.2
 
 * FMERequestsSession: Fix use of Windows Certificate Store in

diff --git a/docs/conf.py b/docs/conf.py
@@ -27,7 +27,7 @@
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "fmeobjects": ("https://docs.safe.com/fme/html/fmepython/", None),
+    "pydoc_external": ("https://docs.safe.com/fme/html/fmepython/", None),
     "requests": ("https://requests.readthedocs.io/en/latest/", None),
 }
 

diff --git a/src/fmetools/__init__.py b/src/fmetools/__init__.py
@@ -1,6 +1,6 @@
 # coding: utf-8
 
-__version__ = "0.10.2"
+__version__ = "0.10.3"
 
 import gettext
 import os

diff --git a/src/fmetools/plugins.py b/src/fmetools/plugins.py
@@ -458,7 +458,7 @@ class FMEEnhancedTransformer(FMEBaseTransformer):
         This class overrides :meth:`has_support_for` to return ``True`` for Bulk Mode support.
         This means that the transformer cannot cache or copy features for later use,
         and cannot output new :class:`fmeobjects.FMEFeature` instances.
-        See :meth:`fmetools._deprecated.FMEBaseTransformer.has_support_for` for details about these restrictions.
+        See :meth:`fme.BaseTransformer.has_support_for` for details about these restrictions.
     """
 
     def __init__(self):
@@ -663,7 +663,7 @@ def has_support_for(self, support_type: int) -> bool:
         Overrides the default implementation to report support for Bulk Mode.
 
         :returns: ``True`` if ``support_type`` is :data:`fmeobjects.FME_SUPPORT_FEATURE_TABLE_SHIM`.
-            See :meth:`fmetools._deprecated.FMEBaseTransformer.has_support_for` for more details.
+            See :meth:`fme.BaseTransformer.has_support_for` for more details.
         """
         if support_type == FME_SUPPORT_FEATURE_TABLE_SHIM:
             return True

diff --git a/tox.ini b/tox.ini
@@ -32,7 +32,9 @@ commands =
 
 [testenv:docs]
 deps =
+    fme-packager>=1.6.0
     sphinx>=6.0.0
     sphinx-rtd-theme>=1.2.2
 commands =
+    fme-packager config-env --fme-home '{env:FME_HOME}'
     sphinx-build docs _build