Skip to content

Allow disabling Sphinx Gallery plots #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 15, 2023
Merged

Allow disabling Sphinx Gallery plots #111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a7c549
Allow disabling Sphinx Gallery plots
stefanv Sep 14, 2023
f26a4bc
Write out sphinx
stefanv Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion spin/cmds/meson.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,9 +499,15 @@ def run(ctx, args):
default=True,
help="Build project before generating docs",
)
@click.option(
"--plot/--no-plot",
"sphinx_gallery_plot",
default=True,
help="Sphinx gallery: enable/disable plots",
)
@click.option("--jobs", "-j", default="auto", help="Number of parallel build jobs")
@click.pass_context
def docs(ctx, sphinx_target, clean, first_build, jobs):
def docs(ctx, sphinx_target, clean, first_build, jobs, sphinx_gallery_plot):
"""📖 Build Sphinx documentation

By default, SPHINXOPTS="-W", raising errors on warnings.
Expand Down Expand Up @@ -559,7 +565,11 @@ def docs(ctx, sphinx_target, clean, first_build, jobs):
sys.exit(1)

opts = os.environ.get("SPHINXOPTS", "-W")
if not sphinx_gallery_plot:
opts = f"{opts} -D plot_gallery=0"

os.environ["SPHINXOPTS"] = f"{opts} -j {jobs}"

click.secho(
f"$ export SPHINXOPTS={os.environ['SPHINXOPTS']}", bold=True, fg="bright_blue"
)
Expand Down