Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support export to dash docs format #108

Open
4 tasks
samaloney opened this issue Mar 11, 2020 · 0 comments
Open
4 tasks

Support export to dash docs format #108

samaloney opened this issue Mar 11, 2020 · 0 comments
Milestone

Comments

@samaloney
Copy link

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.

@nabobalis nabobalis added this to the v2.0.0 milestone Mar 11, 2020
@Cadair Cadair modified the milestones: v2.0.0, v2.1.0 Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants