Merge pull request #1025 from arokem/sphinx_noplot

Adds an option to build the docs without running the examples.
yeatmanlab · Sep 18, 2023 · 7241519 · 7241519
2 parents ac1a009 + 9147d5e
commit 7241519
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -44,4 +44,9 @@ distclean: clean
 realclean: distclean
 	@echo Removing data files from $(HOME)
 	rm -rf $(HOME)/.dipy/
-	rm -rf $(HOME)/AFQ_data/
+	rm -rf $(HOME)/AFQ_data/
+
+html-noplot:
+	$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/docs/source/reference/methods.rst b/docs/source/reference/methods.rst
@@ -336,11 +336,11 @@ reg_subject:
 
 
 bundles:
-    full path to a trk file containing containting segmented streamlines, labeled by bundle
+    full path to a trk/trx file containing containing segmented streamlines, labeled by bundle
 
 
 indiv_bundles:
-    dictionary of paths, where each path is a full path to a trk file containing the streamlines of a given bundle, cleaned or uncleaned
+    dictionary of paths, where each path is a full path to a trk file containing the streamlines of a given bundle.
 
 
 sl_counts: