Describe how to add example notebooks in the documentation guide

[namurphy]

One thing I forgot to include in #1156 was how to add a Jupyter notebook to the examples page in the documentation. Since I'm adding a new notebook in #1380, I figured it was a good time to add documentation on how to do. I haven't added many notebooks, so I'll probably need some help on this one! At the very least, I can get it started.

Closes #1061. #1061 has some pretty useful information in it, so I'll need to read that again too.

[namurphy]

For the moment, I'm putting this directly in the documentation guide. If it gets long, it might be worth creating a separate page on how to add notebooks. To be decided later!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.18%. Comparing base (2a6cf7f) to head (e06b4d3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1381   +/-   ##
=======================================
  Coverage   95.18%   95.18%           
=======================================
  Files         103      103           
  Lines        9412     9412           
  Branches     2153     2153           
=======================================
  Hits         8959     8959           
  Misses        276      276           
  Partials      177      177           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[StanczakDominik]

Which reminds me I've been meaning to mention https://myst-parser.readthedocs.io/en/latest/index.html ...

[namurphy]

I just noticed that there was a section on this already in docs/development/code_guide.rst. In this PR, I think we could take that section, put it onto its own page, and then expand it. Having its own page would be helpful since that would make it easier to find, and would also reduce the scope of the documentation and code guides.

[namurphy]

• Add in a section on how to make colorblind friendly plots (viridis color table as suggested by @qudsiramiz, and colorblind friendly triplets like "#920000", "#006ddb", and "#db6d00")
• Add link to coblis colorblind simulator

[qudsiramiz]

FYI: Both 'Viridis" and "Cividis" are perceptually uniform and colorblind friendly, Cividis though also has the advantage of looking almost identical to both colorblind and non-colorblind users!

[namurphy]

• Describe how to add admonitions in notebooks, as described in this comment.

[namurphy]

I'm putting this on hold for the moment, since what goes in here will depend on if we do end up deciding to switch from nbsphinx to myst_nb in #1474.

[namurphy]

• Add a link to WebPlotDigitizer as a tool for extracting the underlying numerical data from a graphic of a plot. (Not sure if it should go in the coding guide, notebook guide, or testing guide since it could end up being helpful for a bunch of different reasons.)

[github-actions]

Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.

• Overall
  • Does the PR do what it intends to do?
  • Except for very minor changes, is a changelog entry included and consistent with the changelog guide?
  • Are the continuous integration checks passing? (Most linter problems can be automagically fixed by commenting on this PR with pre-commit.ci autofix.)
• Code
  • Is new/updated code understandable and consistent with the coding guide?
  • Are there ways to greatly simplify the implementation?
  • Are there any large functions that should be split up into shorter functions?
• Tests
  • Are tests added/updated as required, and consistent with the testing guide?
  • Are the tests understandable?
  • Do the tests cover all important cases?
• Docs
  • Are docs added/updated as required, and consistent with the doc guide?
  • Are the docs understandable?
  • Do the docs show up correctly in the preview, including Jupyter notebooks?