Skip to content

Building docs with make html-noplot ignores sphinx options #5388

@pmeier

Description

@pmeier

The command currently looks like this:

vision/docs/Makefile

Lines 26 to 27 in 97eddc5

html-noplot: # Avoids running the gallery examples, which may take time
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ASPHINXOPTS) "${SOURCEDIR}" "$(BUILDDIR)"/html

Not that ASPHINXOPTS is non-existent and thus we build without any options. Replacing this with SPHINXOPTS

SPHINXOPTS = -W -j auto $(EXAMPLES_PATTERN_OPTS)

leads to a warning of sphinx gallery (see sphinx-gallery/sphinx-gallery#913) which in turn stops the build in its tracks through our -W usage.

If we don't want these options for html-noplot, I suggest we remove the ASPHINXOPTS substitution. Otherwise, we should probably wait for them to fix this.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions