Fix docs build (#269)

hemildesai · web-flow · commit 7593d213d681 · 2025-06-13T17:14:14.000-07:00
* Fix docs build

Signed-off-by: Hemil Desai &lt;hemild@nvidia.com&gt;

* Fix

Signed-off-by: Hemil Desai &lt;hemild@nvidia.com&gt;

---------

Signed-off-by: Hemil Desai &lt;hemild@nvidia.com&gt;
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,6 +32,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
     "sphinx.ext.napoleon",
+    "sphinxcontrib.mermaid",
 ]
 
 templates_path = ["_templates"]
@@ -59,6 +60,7 @@
 
 # MyST settings
 myst_heading_anchors = 3
+myst_fence_as_directive = ["mermaid"]
 
 # Napoleon settings
 napoleon_google_docstring = True
diff --git a/docs/source/guides/ray.md b/docs/source/guides/ray.md
@@ -1,7 +1,5 @@
 # Ray Clusters & Jobs
 
----
-
 > **Audience**: You already know how to configure executors with NeMo-Run and want distributed *Ray* on either Kubernetes **or** Slurm.
 >
 > **TL;DR**: `RayCluster` manages the _cluster_; `RayJob` submits a job with an ephemeral cluster.  Everything else is syntactic sugar.
diff --git a/pyproject.toml b/pyproject.toml
@@ -84,7 +84,8 @@ docs = [
     "myst-parser",
     "sphinx>=7",
     "sphinx-autoapi>=3.0.0",
-    "nvidia-sphinx-theme"
+    "nvidia-sphinx-theme",
+    "sphinxcontrib-mermaid",
 ]
 
 [build-system]

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,5 @@`
`1`	`1`	`# Ray Clusters & Jobs`
`2`	`2`
`3`		`----`
`4`		`-`
`5`	`3`	`> Audience: You already know how to configure executors with NeMo-Run and want distributed Ray on either Kubernetes or Slurm.`
`6`	`4`	`>`
`7`	`5`	> TL;DR: `RayCluster` manages the _cluster_; `RayJob` submits a job with an ephemeral cluster. Everything else is syntactic sugar.
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,8 @@ docs = [`
`84`	`84`	`"myst-parser",`
`85`	`85`	`"sphinx>=7",`
`86`	`86`	`"sphinx-autoapi>=3.0.0",`
`87`		`- "nvidia-sphinx-theme"`
	`87`	`+ "nvidia-sphinx-theme",`
	`88`	`+ "sphinxcontrib-mermaid",`
`88`	`89`	`]`
`89`	`90`
`90`	`91`	`[build-system]`