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

hide code blocks in examples #1864

Open
neuromusic opened this issue Apr 10, 2020 · 0 comments
Open

hide code blocks in examples #1864

neuromusic opened this issue Apr 10, 2020 · 0 comments
Labels
docs documentation improvements

Comments

@neuromusic
Copy link
Collaborator

neuromusic commented Apr 10, 2020

Many of the examples have boilerplate code that downloads example data and performs required pre-processing before the useful part of the documentation starts. We'd like to hide this content as much as possible.

Possible solutions...

(1) hide it on the front end
We can leave the code as-is in the example sphinx gallery scripts and modify the output.

Options:

  • make sure that tagged blocks don't render in HTML
  • allow the user to toggle tagged blocks

(2) hide it in the API
We can minimize the boilerplate by adding components to the data module that give the user pre-processed data. This could be pre-processed data that we have stored on AWS, but there's a risk that this becomes out-of-date if there are updates to starfish in the future. Another option would be API components that wrap the current boilerplate and cache the results locally. The pre-processing steps would only happen the first time the code is called.

@neuromusic neuromusic added the docs documentation improvements label Apr 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant