Skip to content

Improve findability of example plots in the docs #102

@cdeil

Description

@cdeil

Currently via the astroplan.plots API docs, it's clear that we currently have three plots ... here's the API docs:

The Plotting with Astroplan section does include examples for plot_airmass and plot_sky, but not for plot_parallactic (it mentions it, but no example shown). It took me a while to find an example of plot_parallactic ... it's in a parallactic angle section in the summer triangle tutorial

One thing that can be improved easily would be to link from the docstrings of the plot functions to the sections of the docs that contain examples of that plot.

Concerning the fact that no example parallactic plot is in the "Plotting with Astroplan" section, I'm not sure. Either add one (or move it from the summer triangle tutorial), or link to the existing example in the summer triangle tutorial.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions