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

Create a template notebook for example gallery #1452

Open
10 tasks
namurphy opened this issue Feb 28, 2022 · 0 comments
Open
10 tasks

Create a template notebook for example gallery #1452

namurphy opened this issue Feb 28, 2022 · 0 comments
Labels
good first issue Good first contributions for new contributors notebooks Related to example Jupyter notebooks in docs/examples/

Comments

@namurphy
Copy link
Member

I was thinking that it'd be helpful to have a template Jupyter notebook to simplify the process of adding new notebooks to our gallery.

I'm thinking that the notebook should include...

  • An example link to the documentation page on how to create notebooks (currently being developed in Describe how to add example notebooks in the documentation guide #1381)
  • A relative link to access a code object in PlasmaPy (like plasmapy.formulary.speeds.Alfven_speed)
  • A link to access another notebook in the gallery
  • A link to an external website
  • A table of contents
  • Sample math
  • Sample in-line code like `import this`

Also, we would need to...

  • Add a link to the example notebook from the contributor guide page on notebook (currently underway in Describe how to add example notebooks in the documentation guide #1381)
  • Describe how to make sure the notebook is included in the gallery via the index page
  • Make sure that the notebook does not appear in the online gallery (which we should be able to do by putting the template in its own directory that isn't included in the template page)
@namurphy namurphy changed the title Create a template notebook Create a template notebook for example gallery Feb 28, 2022
@namurphy namurphy added good first issue Good first contributions for new contributors notebooks Related to example Jupyter notebooks in docs/examples/ labels Mar 22, 2022
@github-actions github-actions bot added the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label May 22, 2022
@namurphy namurphy removed the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good first contributions for new contributors notebooks Related to example Jupyter notebooks in docs/examples/
Projects
None yet
Development

No branches or pull requests

1 participant