Fixes for external doc build.

safesoftware · Jul 13, 2023 · c095671 · c095671
1 parent ba7936e
commit c095671
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -16,6 +16,8 @@ jobs:
       - name: Install dependencies
         run: |
             pip install sphinx sphinx_rtd_theme
+            pip install six pypac requests
+            pip install -e .
       - name: Sphinx build
         run: |
             sphinx-build docs _build

diff --git a/docs/conf.py b/docs/conf.py
@@ -28,9 +28,11 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "fmeobjects": ("https://docs.safe.com/fme/html/fmepython/", None),
+    "requests": ("https://requests.readthedocs.io/en/latest/", None),
 }
 
 autodoc_default_options = {
     "special-members": "__init__",
     "show-inheritance": True,
 }
+autodoc_mock_imports = ["fme", "fmeobjects", "fmewebservices", "pluginbuilder"]
diff --git a/docs/fmetools/index.rst b/docs/fmetools/index.rst
@@ -7,7 +7,6 @@ fmetools API reference
     These components are not documented here and may change without notice.
 
 .. module:: fmetools
-   :members:
 
 .. toctree::
    :maxdepth: 2

diff --git a/src/fmetools/plugins.py b/src/fmetools/plugins.py
@@ -643,7 +643,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:`FMEBaseTransformer.has_support_for` for more details.
+            See :meth:`FMEBaseTransformer.has_support_for` for more details.
         """
         if support_type == FME_SUPPORT_FEATURE_TABLE_SHIM:
             return True