Add documentation to every function and automatic doc html building (#6)

Reviewed-on: Rubydragon/MetagraphOptimization.jl#6
Co-authored-by: Anton Reinhard <anton.reinhard@proton.me>
Co-committed-by: Anton Reinhard <anton.reinhard@proton.me>

src/node/create.jl

@@ -1,23 +1,53 @@
+"""
+    make_node(t::AbstractTask)
+
+Fallback implementation of `make_node` for an [`AbstractTask`](@ref), throwing an error.
+"""
 function make_node(t::AbstractTask)
     return error("Cannot make a node from this task type")
 end
 
+"""
+    make_node(t::AbstractDataTask)
+
+Construct and return a new [`DataTaskNode`](@ref) with the given task.
+"""
 function make_node(t::AbstractDataTask)
     return DataTaskNode(t)
 end
 
+"""
+    make_node(t::AbstractComputeTask)
+
+Construct and return a new [`ComputeTaskNode`](@ref) with the given task.
+"""
 function make_node(t::AbstractComputeTask)
     return ComputeTaskNode(t)
 end
 
+"""
+    make_edge(n1::Node, n2::Node)
+
+Fallback implementation of `make_edge` throwing an error. If you got this error it likely means you tried to construct an edge between two nodes of the same type.
+"""
 function make_edge(n1::Node, n2::Node)
     return error("Can only create edges from compute to data node or reverse")
 end
 
+"""
+    make_edge(n1::ComputeTaskNode, n2::DataTaskNode)
+
+Construct and return a new [`Edge`](@ref) pointing from `n1` (child) to `n2` (parent).
+"""
 function make_edge(n1::ComputeTaskNode, n2::DataTaskNode)
     return Edge((n1, n2))
 end
 
+"""
+    make_edge(n1::DataTaskNode, n2::ComputeTaskNode)
+
+Construct and return a new [`Edge`](@ref) pointing from `n1` (child) to `n2` (parent).
+"""
 function make_edge(n1::DataTaskNode, n2::ComputeTaskNode)
     return Edge((n1, n2))
 end