Skip to content

Don't include developer docs in stable branch #10443

Description

@astrofrog

Accepted Solution

  1. Hide the dev docs in stable builds w/ link to the latest, show in dev builds (this is what Sunpy does right now)

Original Post

This came out of suggestions by both @aarchiba and @Cadair - one issue with the developer documentation at the moment is that the version at 'stable' (the default which people will see) might be out of date by up to 6 months. The easiest solution (which is what SunPy does) would be to basically remove the developer docs in release branches (and therefore the stable branch) and keep the dev docs in 'latest'. Then when going to the stable docs or any fixed release docs, instead of:

Screenshot 2020-06-04 at 14 17 54

users would see:

Screenshot 2020-06-04 at 14 19 58

and clicking on the link would take them to:

Screenshot 2020-06-04 at 14 17 54

in the latest developer docs. Any objections to this?

Metadata

Metadata

Assignees

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions