Animations in example gallery do not animate

Open
#721 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with docs/conf.py and compare its Sphinx Gallery configuration with the setting in the linked sunpy docs/conf.py. Check the affected generated gallery example to confirm the animation is rendered after the configuration change; done means the example gallery displays the result as an animation.

Written by the indexing model from the issue text.

Description

Documentation help wanted

There is at least one example gallery entry that shows a resulting animation (https://docs.sunpy.org/projects/ndcube/en/latest/generated/gallery/creating_even_spaced_wavelength_visualisation.html#sphx-glr-generated-gallery-creating-even-spaced-wavelength-visualisation-py), but that animation is not actually animated in the rendered example gallery. To enable this, we should be setting the following config option in the sphinx gallery config as in sunpy,

https://github.com/sunpy/sunpy/blob/a986291976a7e250924197455f09630847706824/docs/conf.py#L28

Dominant language
Python
Stars
49
Forks
56
Avg merge
5h 54m
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sunpy/ndcube

All issues in sunpy/ndcube

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.