Remove unsupported auto-hyperlinking from docstrings (#1425)

* Should only use in the `docs` themselves

Signed-off-by: Elliot Gunton <[email protected]>

Author: elliotgunton

src/hera/workflows/artifact.py

@@ -153,7 +153,7 @@ def as_name(self, name: str) -> _ModelArtifact:
         """Returns a 'built' copy of the current artifact, renamed using the specified `name`.
 
         Warning: DEPRECATED
-            use [with_name][hera.workflows.artifact.Artifact.as_name].
+            use with_name.
         """
         _logger.warning("'as_name' is deprecated, use 'with_name'")
         artifact = self._build_artifact()

src/hera/workflows/dag.py

@@ -28,7 +28,7 @@ class DAG(
 ):
     """A DAG template invocator is used to define Task dependencies as an acyclic graph.
 
-    DAG implements the contextmanager interface so allows usage of `with`, under which any [Task][hera.workflows.Task]
+    DAG implements the contextmanager interface so allows usage of `with`, under which any Task
     objects instantiated will be added to the DAG's list of Tasks.
 
     See the [DAG examples](../../../examples/workflows/dags/dag_diamond_with_script.md) for usage.

src/hera/workflows/resources.py

@@ -1,4 +1,4 @@
-"""The `hera.workflows.resources` module provides the [Resources][hera.workflows.resources.Resources] class for setting CPU, memory and other limits."""
+"""The `hera.workflows.resources` module provides the Resources class for setting CPU, memory and other limits."""
 
 from typing import Dict, Optional, Union
 

src/hera/workflows/script.py

@@ -138,9 +138,9 @@ class Script(
     ResourceMixin,
     VolumeMountMixin,
 ):
-    """A Script in Argo Workflows acts as a wrapper around a [Container][hera.workflows.container.Container], where you can specify Python code to run through `source`.
+    """A Script in Argo Workflows acts as a wrapper around a Container, where you can specify Python code to run through `source`.
 
-    In Hera, you should aim to use the [script decorator][hera.workflows.script.script], rather than the Script class directly.
+    In Hera, you should aim to use the script decorator, rather than the Script class directly.
     You will need to refer to the Script class for the kwargs that the decorator can take, but your IDE should give you code completion and type hints.
     """
 
@@ -665,7 +665,7 @@ def _add_type_hints(
 
 @_add_type_hints(Script)
 def script(**script_kwargs) -> Callable:
-    """A decorator that wraps a function into a [Script][hera.workflows.script.Script] object.
+    """A decorator that wraps a function into a Script object.
 
     Using this decorator users can define a function that will be executed as a script in a container. Once the
     `Script` is returned users can use it as they generally use a `Script` e.g. as a callable inside a DAG or Steps.

src/hera/workflows/steps.py

@@ -36,7 +36,7 @@ def __exit__(self, *_):
 
 
 def parallel():
-    """Open a parallel context within a [steps-decorator function][hera.workflows.workflow.Workflow.steps].
+    """Open a parallel context within a steps-decorator function.
 
     When running locally, the context will be a no-op.
     """
@@ -100,7 +100,7 @@ class Parallel(
     ContextMixin,
     SubNodeMixin,
 ):
-    """Parallel is a context manager used to create a list of [steps][hera.workflows.steps.Step] to run in parallel.
+    """Parallel is a context manager used to create a list of steps to run in parallel.
 
     Parallel implements the context manager interface so allows usage of `with`, under which any
     `hera.workflows.steps.Step` objects instantiated will be added to Parallel's list of sub_steps.

src/hera/workflows/template_set.py

@@ -1,6 +1,6 @@
 """The `hera.workflows.template_set` module provides the TemplateSet class.
 
-The `TemplateSet` class lets you create a collection of templates unattached to a [Workflow][hera.workflows.workflow.Workflow].
+The `TemplateSet` class lets you create a collection of templates unattached to a Workflow.
 
 Warning:
     This class is only for use with experimental Workflow decorators. [Read the guide here](../../../user-guides/decorators.md).

src/hera/workflows/user_container.py

@@ -1,7 +1,6 @@
 """The `hera.workflows.user_container` module provides user container functionality and objects.
 
-[UserContainers][hera.workflows.user_container.UserContainer] are used as side containers, so they can run background
-processes required for the main container.
+UserContainers are used as side containers, so they can run background processes required for the main container.
 """
 
 from typing import List, Optional, Union, cast