astropy / astropy/astroplan

Add a Sphinx plot gallery?

Open
#12 7 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
225
Forks
121
Avg merge
28m
Merged PRs (30d)
1

Description

@jberlanga, @adrn, all – What do you think about adding a sphinx plot gallery to the `astroplan` docs.
I haven't used this, but I think it's very easy to do:
http://sphinx-gallery.readthedocs.org/en/latest/auto_examples/index.html#examples-index

I wasn't sure if it's a good idea at all, and if so it's probably for later (although it could just as well be set up now), so I made a separate issue from #7 for discussion ...

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the current astroplan documentation and the linked Sphinx Gallery examples-index; the issue names no repository files or tests. Confirm whether a gallery is wanted and, if so, define the documentation entry point and acceptance criteria before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.