graph and job apidoc fixes (#7673)

dagster-io · May 2, 2022 · 0422087 · 0422087 · vercel · May 2, 2022
1 parent d79bb7b
commit 0422087
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 11 deletions.
diff --git a/docs/sphinx/sections/api/apidocs/graphs.rst b/docs/sphinx/sections/api/apidocs/graphs.rst
@@ -2,7 +2,7 @@
 Graphs
 ======
 
-The replacement for :py:class:`composite_solid` / :py:class:`CompositeSolidDefinition` . It has a more intuitive name and there is no longer a distinction between a graph for execution (pipeline) and a graph for composition (composite solid).
+The core of a job is a _graph_ of ops - connected via data dependencies.
 
 .. currentmodule:: dagster
 
@@ -14,3 +14,14 @@ The replacement for :py:class:`composite_solid` / :py:class:`CompositeSolidDefin
 .. autoclass:: GraphIn
 
 .. autoclass:: GraphOut
+
+
+Explicit dependencies
+------------------------
+.. currentmodule:: dagster
+
+.. autoclass:: DependencyDefinition
+
+.. autoclass:: MultiDependencyDefinition
+
+.. autoclass:: NodeInvocation
diff --git a/docs/sphinx/sections/api/apidocs/jobs.rst b/docs/sphinx/sections/api/apidocs/jobs.rst
@@ -1,7 +1,7 @@
 Jobs
 ====
 
-The replacement for :py:class:`pipeline` / :py:class:`PipelineDefinition`, a ``Job`` binds a ``Graph`` and the resources it needs to be executable.
+A ``Job`` binds a ``Graph`` and the resources it needs to be executable.
 
 Jobs are created by calling :py:meth:`GraphDefinition.to_job` on a graph instance, or using the :py:class:`job` decorator.
 

diff --git a/docs/sphinx/sections/api/apidocs/pipeline.rst b/docs/sphinx/sections/api/apidocs/pipeline.rst
@@ -49,15 +49,6 @@ Reconstructable pipelines
 .. autoclass:: ReconstructablePipeline
    :members:
 
-Dependencies and aliases
-------------------------
-.. currentmodule:: dagster
-
-.. autoclass:: DependencyDefinition
-
-.. autoclass:: MultiDependencyDefinition
-
-.. autoclass:: SolidInvocation
 
 Pipeline configuration
 ----------------------
@@ -129,3 +120,10 @@ Run Config Schema
         },
 
       }
+
+Aliases
+-------
+
+.. currentmodule:: dagster
+
+.. autoclass:: SolidInvocation
diff --git a/python_modules/dagster/dagster/core/definitions/dependency.py b/python_modules/dagster/dagster/core/definitions/dependency.py
@@ -67,6 +67,7 @@ class NodeInvocation(
     :py:func:`@job <job>` API:
 
     .. code-block:: python
+
         from dagster import job
 
         @job