fix

Author: tobiasraabe

.pre-commit-config.yaml

@@ -60,7 +60,7 @@ repos:
             mdformat-pyproject>=0.0.2,
         ]
         files: (docs/.)
-        exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/reference_guides/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md)
+        exclude: (docs/source/reference_guides/hookspecs\.md|docs/source/reference_guides/api/.*\.md|docs/source/how_to_guides/capture_warnings\.md|docs/source/how_to_guides/hashing_inputs_of_tasks\.md|docs/source/how_to_guides/provisional_nodes_and_task_generators\.md|docs/source/how_to_guides/remote_files\.md|docs/source/how_to_guides/writing_custom_nodes\.md|docs/source/tutorials/defining_dependencies_products\.md|docs/source/tutorials/using_a_data_catalog\.md|docs/source/tutorials/write_a_task\.md|docs/source/tutorials/visualizing_the_dag.md)
 -   repo: https://github.com/kynan/nbstripout
     rev: 0.9.1
     hooks:

docs/source/how_to_guides/hashing_inputs_of_tasks.md

@@ -1,7 +1,7 @@
 # Hashing inputs of tasks
 
 Any input to a task function is parsed by pytask's nodes. For example,
-[pathlib.Path][]s are parsed by
+[`pathlib.Path`][]s are parsed by
 [`pytask.PathNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PathNode)s. The
 [`pytask.PathNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PathNode) handles among other things
 how changes in the underlying file are detected.

docs/source/how_to_guides/provisional_nodes_and_task_generators.md

@@ -36,7 +36,7 @@ the directory of the task module) and a glob pattern (default is `*`).
 
 When we use the [`pytask.DirectoryNode`](../reference_guides/api/nodes_and_tasks.md#pytask.DirectoryNode)
 as a product annotation, we get access to the `root_dir` as a
-[pathlib.Path][] object inside the function, which allows us to store
+[`pathlib.Path`][] object inside the function, which allows us to store
 the files.
 
 !!! note

docs/source/how_to_guides/writing_custom_nodes.md

@@ -3,7 +3,7 @@
 In the previous tutorials and how-to guides, you learned that dependencies and products
 can be represented as plain Python objects with
 [`pytask.PythonNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PythonNode) or as paths where every
-[pathlib.Path][] is converted to a
+[`pathlib.Path`][] is converted to a
 [`pytask.PathNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PathNode).
 
 In this how-to guide, you will learn about the general concept of nodes and how to write
@@ -114,7 +114,7 @@ Here are some explanations.
 
 ## Improvements
 
-Usually, you would like your custom node to work with [pathlib.Path][] objects and
+Usually, you would like your custom node to work with [`pathlib.Path`][] objects and
 [upath.UPath][] objects allowing to work with remote
 filesystems. To simplify getting the state of the node, you can use the
 [`pytask.get_state_of_path`](../reference_guides/api/utilities_and_typing.md#pytask.get_state_of_path)

docs/source/tutorials/using_a_data_catalog.md

@@ -56,7 +56,7 @@ Next, we look at the module `task_data_preparation.py` and its task
 be stored on the disk.
 
 In the previous tutorial, we learned to use
-[pathlib.Path][]s to define
+[`pathlib.Path`][]s to define
 products of our tasks. Here we see again the signature of the task function.
 
 === "Annotated"
@@ -175,12 +175,12 @@ path means the location is relative to the module of the data catalog.
 ```
 
 You can now use the data catalog as in the previous example and use the
-[pathlib.Path][] in the task.
+[`pathlib.Path`][] in the task.
 
 !!! note
 
     Note that the value of `data_catalog["csv"]` inside the task becomes a
-    [pathlib.Path][]. It is because a [pathlib.Path][] in
+    [`pathlib.Path`][]. It is because a [`pathlib.Path`][] in
     [`pytask.DataCatalog.add`](../reference_guides/api/core_classes_and_exceptions.md#pytask.DataCatalog.add)
     is not parsed to a [`pytask.PickleNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PickleNode)
     but a [`pytask.PathNode`](../reference_guides/api/nodes_and_tasks.md#pytask.PathNode).

docs/source/tutorials/visualizing_the_dag.md

@@ -53,15 +53,15 @@ Similar to
 [`pytask.build`](../reference_guides/api/functional_interfaces.md#pytask.build), there
 exists
 [`pytask.build_dag`](../reference_guides/api/functional_interfaces.md#pytask.build_dag)
-which returns the DAG as a [networkx.DiGraph][].
+which returns the DAG as a [`networkx.DiGraph`][].
 
 Create an executable script that you can execute with `python script.py`.
 
 ```py
 --8<-- "docs_src/tutorials/visualizing_the_dag.py"
 ```
 
-Customization works best on the [networkx.DiGraph][]. For example, here, we set the
+Customization works best on the [`networkx.DiGraph`][]. For example, here, we set the
 shape of all nodes to hexagons by adding the property to the node attributes.
 
 For drawing, you better switch to pygraphviz since the matplotlib backend handles shapes

docs/source/tutorials/write_a_task.md

@@ -48,7 +48,7 @@ necessary for pytask to correctly run a workflow. The interfaces are ordered fro
 
     The type hint `Annotated[Path, Product]` uses
     [`typing.Annotated`](https://docs.python.org/3/library/typing.html#typing.Annotated)
-    syntax. The first entry specifies the argument type ([pathlib.Path][]), and the second
+    syntax. The first entry specifies the argument type ([`pathlib.Path`][]), and the second
     entry
     ([`pytask.Product`](../reference_guides/api/utilities_and_typing.md#pytask.Product))
     marks this argument as a product.

mkdocs.yml

@@ -7,6 +7,7 @@ site_description: pytask is a workflow management system that facilitates reprod
 use_directory_urls: false
 validation:
   unresolved_footnotes: false
+  # https://github.com/zensical/zensical/issues/600
   unresolved_references: false
 docs_dir: docs/source
 site_dir: docs/build