astropy / astropy/astroquery

Use plot directive to generate figures

Open
#3,027 0 comments 0 reactions 0 assignees View on GitHub
cleanup Documentation Upstream
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

Currently we have a couple of pngs in the documentation that could be generated by the examples instead, using the `plot` directive. However, it is currently blocked by https://github.com/scientific-python/pytest-doctestplus/issues/219 as we saw in #2855 (that would needed `doctest-remote-data` to work along with `plot`)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the documentation PNGs mentioned in the issue, then read #2855 and pytest-doctestplus issue #219 to understand the blocker around combining doctest-remote-data with the plot directive. Once that dependency supports the workflow, replace the applicable static figures with figures generated by the examples and verify the documentation build and doctests succeed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.