Skip to content

Support export to dash docs format #108

Open
@samaloney

Description

The dash docs format is supported by a number of offline/enhanced documentation browsers (e.g dash, zeal) it would be nice to have this option for Sunpy.

The tool to create the documentation sets supports sphinx out of the box and I was able to get a decent looking version by hacking my local version of the theme deleting the contents of navbar.html and docsidebar.html.

image

From my experimenting four major things need to be done:

  • Remove or make top navbar scroll with page
  • Remove sidebar
  • Include guides section in application TOC
  • Include example gallery in application TOC

I think the first two could by handled by having a different set of templates and changing that with a command line arg. The last two I'm not sure about need to see what Matplotlib does for example.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions