Skip to content

Commit de27da7

Browse files
committed
DOC: explain html-skip-subdirs in documenting guide
1 parent d2fc626 commit de27da7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ Other useful invocations include
7171
# save time.
7272
make html-noplot
7373
74+
# Build the html documentation, but skip specific subdirectories. If a gallery
75+
# directory is skipped, the gallery images are not generated. The first
76+
# time this is run, it creates ``.mpl_skip_subdirs.yaml`` which can be edited
77+
# to add or remove subdirectories
78+
make html-skip-subdirs
79+
7480
# Delete built files. May help if you get errors about missing paths or
7581
# broken links.
7682
make clean

0 commit comments

Comments
 (0)