Add example notebook for PlasmaPy particles

.github/workflows/testing.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+    - stable
+    - v0.*.x
+    tags:
+    - v*
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  documentation:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.8
+    - name: Install Python dependencies
+      run: python -m pip install --progress-bar off --upgrade tox
+    - name: Install language-pack-fr and tzdata
+      run: sudo apt-get install graphviz pandoc gfortran
+    - name: Build gallery
+      run: tox

.gitignore

@@ -1,5 +1,6 @@
 .tox/
 generated/
 _build/
+.idea
 gallery/pydata/
-gallery/themis_data/
+gallery/themis_data/

README.md

@@ -14,10 +14,10 @@ To contribute a new tutorial please provide a pull request. All tutorial files
 are stored in the `gallery\` directory and must be a python file. The gallery
 uses the [sphinx gallery](https://sphinx-gallery.readthedocs.io/en/latest/)
 plugin and all output including plots are generated automatically. You can see
-an example gallery [here](https://sphinx-gallery.readthedocs.io/en/latest/auto_examples/index.html).
+an example gallery [here](https://sphinx-gallery.github.io/stable/auto_examples/index.html).
 The [SunPy gallery](http://docs.sunpy.org/en/stable/generated/gallery/index.html) is also a good example.
 For the required syntax see the
-[sphinx gallery syntax](https://sphinx-gallery.readthedocs.io/en/latest/syntax.html)
+[sphinx gallery syntax](https://sphinx-gallery.github.io/stable/syntax.html)
 documentation. Since the syntax is fairly straightforward you may also just
 refer to an existing tutorial file.
 

conf.py

@@ -21,15 +21,14 @@
 # -- Project information -----------------------------------------------------
 
 project = 'PyHC Tutorials'
-copyright = '2021, PyHC'
+copyright = '2018–2022, PyHC'
 author = 'PyHC'
 
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
 release = ''
 
-
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -61,7 +60,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -71,7 +70,6 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -205,10 +203,10 @@
     'matplotlib': ('https://matplotlib.org/',
                    (None, 'http://data.astropy.org/intersphinx/matplotlib.inv')),
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'sunpy': ('http://docs.sunpy.org/en/stable/', None)
+    'sunpy': ('http://docs.sunpy.org/en/stable/', None),
+    'plasmapy': ('https://docs.plasmapy.org/en/stable', None),
 }
 
-
 extensions += ["sphinx_gallery.gen_gallery"]
 path = pathlib.Path.cwd()
 example_dir = path.joinpath('gallery')

gallery/coordinate_systems.py

@@ -10,6 +10,7 @@
 """
 
 ##############################################################################
+
 !pip install spacepy
 from spacepy.coordinates import Coords
 import spacepy.time as spt