Support export to dash docs format
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start by locating the Sphinx theme templates, especially navbar.html and docsidebar.html, and review how the theme handles command-line options. Compare the generated Dash documentation and Matplotlib's approach to including guides and the example gallery in the application TOC. Done means the four listed requirements are addressed and the output works in Dash or Zeal.
Written by the indexing model from the issue text.
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.
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.
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 17
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sunpy/sunpy-sphinx-theme
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
sunpy/sunpy-sphinx-theme#337 ·
-
rtd_enhanced_search.js hits v3 API without version, RTD returns stable results on non-stable buildsOpen
Difficulty 3/5 1-2 days Newbie friendliness 72/100
sunpy/sunpy-sphinx-theme#327 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
sunpy/sunpy-sphinx-theme#321 · 1 comment ·
-
Enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
sunpy/sunpy-sphinx-theme#308 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
sunpy/sunpy-sphinx-theme#300 ·
All issues in sunpy/sunpy-sphinx-theme
Similar issues
-
[Bug] @deck.gl/arcgis dist import resolves to unpublished @deck.gl/core source path (9.3.11, 9.4.0)Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
stac-utils/stac-fields#42 ·
-
[sec-check] SVG remote-reference gate misses src attributes, link hrefs and bare-string @importOpenagent/security hive/hosted-available-lke648397-260827-5n31 security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
channels:add check:passed
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 2 days