We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Notebook for ExB drift
A Jupyter notebook needs to be created in our documentation that not only shows how to use `plamsapy.formulary.drifts.ExB_drift()` but that also describes the physics behind the drift.  The notebook has to be placed in `/docs/notebooks/` or one of it's sub-directories.  Then the notebook needs to be properly reference in the documentation.

--- END ISSUE ---

Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/conf.py`
Content:
```
1 #!/usr/bin/env python3.6
2 # -*- coding: utf-8 -*-
3 #
4 # PlasmaPy documentation build configuration file, created by
5 # sphinx-quickstart on Wed May 31 18:16:46 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15 
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #
20 
21 import os
22 import sys
23 
24 from datetime import datetime
25 from pkg_resources import parse_version
26 from sphinx.application import Sphinx
27 
28 sys.path.insert(0, os.path.abspath(".."))
29 
30 from plasmapy import __version__ as release
31 
32 # -- General configuration ------------------------------------------------
33 
34 # If your documentation needs a minimal Sphinx version, state it here.
35 #
36 # needs_sphinx = '1.0'
37 
38 # Add any Sphinx extension module names here, as strings. They can be
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40 # ones.
41 extensions = [
42     "sphinx.ext.autodoc",
43     "sphinx.ext.intersphinx",
44     "sphinx.ext.graphviz",
45     "sphinx.ext.mathjax",
46     "sphinx.ext.napoleon",
47     "sphinx_automodapi.automodapi",
48     "sphinx_automodapi.smart_resolver",
49     "nbsphinx",
50     "sphinx_copybutton",
51     "sphinx_gallery.load_style",
52 ]
53 
54 intersphinx_mapping = {
55     "python": ("https://docs.python.org/3", None),
56     "numpy": ("https://numpy.org/doc/stable/", None),
57     "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
58     "pandas": ("http://pandas.pydata.org/pandas-docs/stable/", None),
59     "astropy": ("http://docs.astropy.org/en/stable/", None),
60 }
61 
62 autoclass_content = "both"
63 
64 # Add any paths that contain templates here, relative to this directory.
65 templates_path = ["_templates"]
66 
67 # The suffix(es) of source filenames.
68 # You can specify multiple suffix as a list of string:
69 #
70 # source_suffix = ['.rst', '.md']
71 source_suffix = ".rst"
72 
73 # The master toctree document.
74 master_doc = "index"
75 
76 # General information about the project.
77 project = "PlasmaPy"
78 author = "PlasmaPy Community"
79 copyright = f"2015-{datetime.utcnow().year}, {author}"
80 
81 
82 # The version info for the project you're documenting, acts as replacement for
83 # |version| and |release|, also used in various other places throughout the
84 # built documents.
85 #
86 # The full version, including alpha/beta/rc tags.
87 #  Note: If plasmapy.__version__ can not be defined then it is set to 'unknown'.
88 #        However, release needs to be a semantic style version number, so set
89 #        the 'unknown' case to ''.
90 release = "" if release == "unknown" else release
91 if release == "unknown":
92     release = version = revision = ""
93 else:
94     pv = parse_version(release)
95     release = pv.public
96     version = ".".join(release.split(".")[:2])  # short X.Y version
97     if pv.local is not None:
98         revision = pv.local[1:]  # revision number w/o the leading g
99     else:
100         revision = ""
101 
102 
103 # The language for content autogenerated by Sphinx. Refer to documentation
104 # for a list of supported languages.
105 #
106 # This is also used if you do content translation via gettext catalogs.
107 # Usually you set "language" from the command line for these cases.
108 language = None
109 
110 # List of patterns, relative to source directory, that match files and
111 # directories to ignore when looking for source files.
112 # This patterns also effect to html_static_path and html_extra_path
113 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
114 
115 # The name of the Pygments (syntax highlighting) style to use.
116 pygments_style = "sphinx"
117 
118 # If true, `todo` and `todoList` produce output, else they produce nothing.
119 todo_include_todos = False
120 
121 default_role = "obj"
122 
123 # -- Options for HTML output ----------------------------------------------
124 
125 # The theme to use for HTML and HTML Help pages.  See the documentation for
126 # a list of builtin themes.
127 #
128 # html_theme = 'alabaster'
129 # html_theme = 'traditional'
130 # html_theme = 'agogo'
131 html_theme = "sphinx_rtd_theme"
132 
133 # Theme options are theme-specific and customize the look and feel of a theme
134 # further.  For a list of options available for each theme, see the
135 # documentation.
136 #
137 html_logo = "./_static/with-text-light-190px.png"
138 html_theme_options = {
139     "logo_only": True,
140     #
141     # TOC options
142     #   https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options
143     "includehidden": False,
144 }
145 
146 # Add any paths that contain custom static files (such as style sheets) here,
147 # relative to this directory. They are copied after the builtin static files,
148 # so a file named "default.css" will overwrite the builtin "default.css".
149 html_static_path = ["_static"]
150 
151 # A list of prefixes that are ignored for sorting the Python module
152 # index (e.g., if this is set to ['foo.'], then foo.bar is shown under
153 # B, not F).
154 modindex_common_prefix = ["plasmapy."]
155 
156 # -- Options for HTMLHelp output ------------------------------------------
157 
158 # Output file base name for HTML help builder.
159 htmlhelp_basename = "PlasmaPydoc"
160 
161 
162 # -- Options for LaTeX output ---------------------------------------------
163 
164 latex_elements = {
165     # The paper size ('letterpaper' or 'a4paper').
166     # 'papersize': 'letterpaper',
167     #
168     # The font size ('10pt', '11pt' or '12pt').
169     # 'pointsize': '10pt',
170     #
171     # Additional stuff for the LaTeX preamble.
172     # 'preamble': '',
173     #
174     # Latex figure (float) alignment
175     # 'figure_align': 'htbp',
176 }
177 
178 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title,
180 #  author, documentclass [howto, manual, or own class]).
181 latex_documents = [
182     (
183         master_doc,
184         "PlasmaPy.tex",
185         "PlasmaPy Documentation",
186         "PlasmaPy Community",
187         "manual",
188     )
189 ]
190 
191 
192 # -- Options for manual page output ---------------------------------------
193 
194 # One entry per manual page. List of tuples
195 # (source start file, name, description, authors, manual section).
196 man_pages = [(master_doc, "plasmapy", "PlasmaPy Documentation", [author], 1)]
197 
198 
199 # -- Options for Texinfo output -------------------------------------------
200 
201 # Grouping the document tree into Texinfo files. List of tuples
202 # (source start file, target name, title, author,
203 #  dir menu entry, description, category)
204 texinfo_documents = [
205     (
206         master_doc,
207         "PlasmaPy",
208         "PlasmaPy Documentation",
209         author,
210         "PlasmaPy",
211         "Python package for plasma physics",
212         "Miscellaneous",
213     )
214 ]
215 
216 html_favicon = "./_static/icon.ico"
217 
218 
219 # -- NBSphinx options
220 
221 nbsphinx_thumbnails = {"notebooks/*": "_images/graphic-circular.png"}
222 
223 # adapted from https://github.com/spatialaudio/nbsphinx/blob/58b8034dd9d7349c1b4ac3e7a7d6baa87ab2a6a9/doc/conf.py
224 
225 # This is processed by Jinja2 and inserted before each notebook
226 nbsphinx_prolog = r"""
227 {% set docname = 'docs/' + env.doc2path(env.docname, base=None) %}
228 {% set nb_base = 'tree' if env.config.revision else 'blob' %}
229 {% set nb_where = env.config.revision if env.config.revision else 'master' %}
230 
231 .. raw:: html
232 
233     <div class="admonition note">
234       <p style="margin-bottom:0px">
235         This page was generated by
236         <a href="https://nbsphinx.readthedocs.io/">nbsphinx</a> from
237         <a class="reference external" href="https://github.com/PlasmaPy/PlasmaPy/{{ nb_base|e }}/{{ nb_where|e }}/{{ docname|e }}">{{ docname|e }}</a>.
238         <br>
239         Interactive online version:
240         <a href="https://mybinder.org/v2/gh/PlasmaPy/PlasmaPy/{{ nb_where|e }}/?filepath={{ docname|e }}"><img alt="Binder badge" src="https://mybinder.org/badge_logo.svg" style="vertical-align:text-bottom"></a>.
241       </p>
242     </div>
243 
244 .. raw:: latex
245 
246     \nbsphinxstartnotebook{\scriptsize\noindent\strut
247     \textcolor{gray}{The following section was generated from
248     \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
249 """
250 
251 
252 def setup(app: Sphinx) -> None:
253     app.add_config_value("revision", "", True)
254     app.add_stylesheet("rtd_theme_overrides.css")
255
```
--- END FILES ---

Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.

Here is an example:

```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
 
 
 if __name__ == "__main__":
-    asyncio.run(run_async_server("."), debug=True)
+    asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
 
 
 if __name__ == "__main__":
-    server = run_sync_server(".")
+    server = run_sync_server()
     server.shutdown()

```

diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -49,6 +49,7 @@
     "nbsphinx",
     "sphinx_copybutton",
     "sphinx_gallery.load_style",
+    "IPython.sphinxext.ipython_console_highlighting",
 ]
 
 intersphinx_mapping = {
@@ -110,10 +111,8 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False

{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -49,6 +49,7 @@\n     \"nbsphinx\",\n     \"sphinx_copybutton\",\n     \"sphinx_gallery.load_style\",\n+    \"IPython.sphinxext.ipython_console_highlighting\",\n ]\n \n intersphinx_mapping = {\n@@ -110,10 +111,8 @@\n # List of patterns, relative to source directory, that match files and\n # directories to ignore when looking for source files.\n # This patterns also effect to html_static_path and html_extra_path\n-exclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\"]\n+exclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\", \"**.ipynb_checkpoints\"]\n \n-# The name of the Pygments (syntax highlighting) style to use.\n-pygments_style = \"sphinx\"\n \n # If true, `todo` and `todoList` produce output, else they produce nothing.\n todo_include_todos = False\n", "issue": "Notebook for ExB drift\nA Jupyter notebook needs to be created in our documentation that not only shows how to use `plamsapy.formulary.drifts.ExB_drift()` but that also describes the physics behind the drift.  The notebook has to be placed in `/docs/notebooks/` or one of it's sub-directories.  Then the notebook needs to be properly reference in the documentation.\n", "before_files": [{"content": "#!/usr/bin/env python3.6\n# -*- coding: utf-8 -*-\n#\n# PlasmaPy documentation build configuration file, created by\n# sphinx-quickstart on Wed May 31 18:16:46 2017.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\n\nimport os\nimport sys\n\nfrom datetime import datetime\nfrom pkg_resources import parse_version\nfrom sphinx.application import Sphinx\n\nsys.path.insert(0, os.path.abspath(\"..\"))\n\nfrom plasmapy import __version__ as release\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n    \"sphinx.ext.autodoc\",\n    \"sphinx.ext.intersphinx\",\n    \"sphinx.ext.graphviz\",\n    \"sphinx.ext.mathjax\",\n    \"sphinx.ext.napoleon\",\n    \"sphinx_automodapi.automodapi\",\n    \"sphinx_automodapi.smart_resolver\",\n    \"nbsphinx\",\n    \"sphinx_copybutton\",\n    \"sphinx_gallery.load_style\",\n]\n\nintersphinx_mapping = {\n    \"python\": (\"https://docs.python.org/3\", None),\n    \"numpy\": (\"https://numpy.org/doc/stable/\", None),\n    \"scipy\": (\"https://docs.scipy.org/doc/scipy/reference/\", None),\n    \"pandas\": (\"http://pandas.pydata.org/pandas-docs/stable/\", None),\n    \"astropy\": (\"http://docs.astropy.org/en/stable/\", None),\n}\n\nautoclass_content = \"both\"\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = [\"_templates\"]\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = \".rst\"\n\n# The master toctree document.\nmaster_doc = \"index\"\n\n# General information about the project.\nproject = \"PlasmaPy\"\nauthor = \"PlasmaPy Community\"\ncopyright = f\"2015-{datetime.utcnow().year}, {author}\"\n\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The full version, including alpha/beta/rc tags.\n#  Note: If plasmapy.__version__ can not be defined then it is set to 'unknown'.\n#        However, release needs to be a semantic style version number, so set\n#        the 'unknown' case to ''.\nrelease = \"\" if release == \"unknown\" else release\nif release == \"unknown\":\n    release = version = revision = \"\"\nelse:\n    pv = parse_version(release)\n    release = pv.public\n    version = \".\".join(release.split(\".\")[:2])  # short X.Y version\n    if pv.local is not None:\n        revision = pv.local[1:]  # revision number w/o the leading g\n    else:\n        revision = \"\"\n\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This patterns also effect to html_static_path and html_extra_path\nexclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\"]\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = \"sphinx\"\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = False\n\ndefault_role = \"obj\"\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages.  See the documentation for\n# a list of builtin themes.\n#\n# html_theme = 'alabaster'\n# html_theme = 'traditional'\n# html_theme = 'agogo'\nhtml_theme = \"sphinx_rtd_theme\"\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further.  For a list of options available for each theme, see the\n# documentation.\n#\nhtml_logo = \"./_static/with-text-light-190px.png\"\nhtml_theme_options = {\n    \"logo_only\": True,\n    #\n    # TOC options\n    #   https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options\n    \"includehidden\": False,\n}\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = [\"_static\"]\n\n# A list of prefixes that are ignored for sorting the Python module\n# index (e.g., if this is set to ['foo.'], then foo.bar is shown under\n# B, not F).\nmodindex_common_prefix = [\"plasmapy.\"]\n\n# -- Options for HTMLHelp output ------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = \"PlasmaPydoc\"\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n    # The paper size ('letterpaper' or 'a4paper').\n    # 'papersize': 'letterpaper',\n    #\n    # The font size ('10pt', '11pt' or '12pt').\n    # 'pointsize': '10pt',\n    #\n    # Additional stuff for the LaTeX preamble.\n    # 'preamble': '',\n    #\n    # Latex figure (float) alignment\n    # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n#  author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n    (\n        master_doc,\n        \"PlasmaPy.tex\",\n        \"PlasmaPy Documentation\",\n        \"PlasmaPy Community\",\n        \"manual\",\n    )\n]\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [(master_doc, \"plasmapy\", \"PlasmaPy Documentation\", [author], 1)]\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n#  dir menu entry, description, category)\ntexinfo_documents = [\n    (\n        master_doc,\n        \"PlasmaPy\",\n        \"PlasmaPy Documentation\",\n        author,\n        \"PlasmaPy\",\n        \"Python package for plasma physics\",\n        \"Miscellaneous\",\n    )\n]\n\nhtml_favicon = \"./_static/icon.ico\"\n\n\n# -- NBSphinx options\n\nnbsphinx_thumbnails = {\"notebooks/*\": \"_images/graphic-circular.png\"}\n\n# adapted from https://github.com/spatialaudio/nbsphinx/blob/58b8034dd9d7349c1b4ac3e7a7d6baa87ab2a6a9/doc/conf.py\n\n# This is processed by Jinja2 and inserted before each notebook\nnbsphinx_prolog = r\"\"\"\n{% set docname = 'docs/' + env.doc2path(env.docname, base=None) %}\n{% set nb_base = 'tree' if env.config.revision else 'blob' %}\n{% set nb_where = env.config.revision if env.config.revision else 'master' %}\n\n.. raw:: html\n\n    <div class=\"admonition note\">\n      <p style=\"margin-bottom:0px\">\n        This page was generated by\n        <a href=\"https://nbsphinx.readthedocs.io/\">nbsphinx</a> from\n        <a class=\"reference external\" href=\"https://github.com/PlasmaPy/PlasmaPy/{{ nb_base|e }}/{{ nb_where|e }}/{{ docname|e }}\">{{ docname|e }}</a>.\n        <br>\n        Interactive online version:\n        <a href=\"https://mybinder.org/v2/gh/PlasmaPy/PlasmaPy/{{ nb_where|e }}/?filepath={{ docname|e }}\"><img alt=\"Binder badge\" src=\"https://mybinder.org/badge_logo.svg\" style=\"vertical-align:text-bottom\"></a>.\n      </p>\n    </div>\n\n.. raw:: latex\n\n    \\nbsphinxstartnotebook{\\scriptsize\\noindent\\strut\n    \\textcolor{gray}{The following section was generated from\n    \\sphinxcode{\\sphinxupquote{\\strut {{ docname | escape_latex }}}} \\dotfill}}\n\"\"\"\n\n\ndef setup(app: Sphinx) -> None:\n    app.add_config_value(\"revision\", \"\", True)\n    app.add_stylesheet(\"rtd_theme_overrides.css\")\n", "path": "docs/conf.py"}], "after_files": [{"content": "#!/usr/bin/env python3.6\n# -*- coding: utf-8 -*-\n#\n# PlasmaPy documentation build configuration file, created by\n# sphinx-quickstart on Wed May 31 18:16:46 2017.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\n\nimport os\nimport sys\n\nfrom datetime import datetime\nfrom pkg_resources import parse_version\nfrom sphinx.application import Sphinx\n\nsys.path.insert(0, os.path.abspath(\"..\"))\n\nfrom plasmapy import __version__ as release\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n    \"sphinx.ext.autodoc\",\n    \"sphinx.ext.intersphinx\",\n    \"sphinx.ext.graphviz\",\n    \"sphinx.ext.mathjax\",\n    \"sphinx.ext.napoleon\",\n    \"sphinx_automodapi.automodapi\",\n    \"sphinx_automodapi.smart_resolver\",\n    \"nbsphinx\",\n    \"sphinx_copybutton\",\n    \"sphinx_gallery.load_style\",\n    \"IPython.sphinxext.ipython_console_highlighting\",\n]\n\nintersphinx_mapping = {\n    \"python\": (\"https://docs.python.org/3\", None),\n    \"numpy\": (\"https://numpy.org/doc/stable/\", None),\n    \"scipy\": (\"https://docs.scipy.org/doc/scipy/reference/\", None),\n    \"pandas\": (\"http://pandas.pydata.org/pandas-docs/stable/\", None),\n    \"astropy\": (\"http://docs.astropy.org/en/stable/\", None),\n}\n\nautoclass_content = \"both\"\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = [\"_templates\"]\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = \".rst\"\n\n# The master toctree document.\nmaster_doc = \"index\"\n\n# General information about the project.\nproject = \"PlasmaPy\"\nauthor = \"PlasmaPy Community\"\ncopyright = f\"2015-{datetime.utcnow().year}, {author}\"\n\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The full version, including alpha/beta/rc tags.\n#  Note: If plasmapy.__version__ can not be defined then it is set to 'unknown'.\n#        However, release needs to be a semantic style version number, so set\n#        the 'unknown' case to ''.\nrelease = \"\" if release == \"unknown\" else release\nif release == \"unknown\":\n    release = version = revision = \"\"\nelse:\n    pv = parse_version(release)\n    release = pv.public\n    version = \".\".join(release.split(\".\")[:2])  # short X.Y version\n    if pv.local is not None:\n        revision = pv.local[1:]  # revision number w/o the leading g\n    else:\n        revision = \"\"\n\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This patterns also effect to html_static_path and html_extra_path\nexclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\", \"**.ipynb_checkpoints\"]\n\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = False\n\ndefault_role = \"obj\"\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages.  See the documentation for\n# a list of builtin themes.\n#\n# html_theme = 'alabaster'\n# html_theme = 'traditional'\n# html_theme = 'agogo'\nhtml_theme = \"sphinx_rtd_theme\"\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further.  For a list of options available for each theme, see the\n# documentation.\n#\nhtml_logo = \"./_static/with-text-light-190px.png\"\nhtml_theme_options = {\n    \"logo_only\": True,\n    #\n    # TOC options\n    #   https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options\n    \"includehidden\": False,\n}\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = [\"_static\"]\n\n# A list of prefixes that are ignored for sorting the Python module\n# index (e.g., if this is set to ['foo.'], then foo.bar is shown under\n# B, not F).\nmodindex_common_prefix = [\"plasmapy.\"]\n\n# -- Options for HTMLHelp output ------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = \"PlasmaPydoc\"\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n    # The paper size ('letterpaper' or 'a4paper').\n    # 'papersize': 'letterpaper',\n    #\n    # The font size ('10pt', '11pt' or '12pt').\n    # 'pointsize': '10pt',\n    #\n    # Additional stuff for the LaTeX preamble.\n    # 'preamble': '',\n    #\n    # Latex figure (float) alignment\n    # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n#  author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n    (\n        master_doc,\n        \"PlasmaPy.tex\",\n        \"PlasmaPy Documentation\",\n        \"PlasmaPy Community\",\n        \"manual\",\n    )\n]\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [(master_doc, \"plasmapy\", \"PlasmaPy Documentation\", [author], 1)]\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n#  dir menu entry, description, category)\ntexinfo_documents = [\n    (\n        master_doc,\n        \"PlasmaPy\",\n        \"PlasmaPy Documentation\",\n        author,\n        \"PlasmaPy\",\n        \"Python package for plasma physics\",\n        \"Miscellaneous\",\n    )\n]\n\nhtml_favicon = \"./_static/icon.ico\"\n\n\n# -- NBSphinx options\n\nnbsphinx_thumbnails = {\"notebooks/*\": \"_images/graphic-circular.png\"}\n\n# adapted from https://github.com/spatialaudio/nbsphinx/blob/58b8034dd9d7349c1b4ac3e7a7d6baa87ab2a6a9/doc/conf.py\n\n# This is processed by Jinja2 and inserted before each notebook\nnbsphinx_prolog = r\"\"\"\n{% set docname = 'docs/' + env.doc2path(env.docname, base=None) %}\n{% set nb_base = 'tree' if env.config.revision else 'blob' %}\n{% set nb_where = env.config.revision if env.config.revision else 'master' %}\n\n.. raw:: html\n\n    <div class=\"admonition note\">\n      <p style=\"margin-bottom:0px\">\n        This page was generated by\n        <a href=\"https://nbsphinx.readthedocs.io/\">nbsphinx</a> from\n        <a class=\"reference external\" href=\"https://github.com/PlasmaPy/PlasmaPy/{{ nb_base|e }}/{{ nb_where|e }}/{{ docname|e }}\">{{ docname|e }}</a>.\n        <br>\n        Interactive online version:\n        <a href=\"https://mybinder.org/v2/gh/PlasmaPy/PlasmaPy/{{ nb_where|e }}/?filepath={{ docname|e }}\"><img alt=\"Binder badge\" src=\"https://mybinder.org/badge_logo.svg\" style=\"vertical-align:text-bottom\"></a>.\n      </p>\n    </div>\n\n.. raw:: latex\n\n    \\nbsphinxstartnotebook{\\scriptsize\\noindent\\strut\n    \\textcolor{gray}{The following section was generated from\n    \\sphinxcode{\\sphinxupquote{\\strut {{ docname | escape_latex }}}} \\dotfill}}\n\"\"\"\n\n\ndef setup(app: Sphinx) -> None:\n    app.add_config_value(\"revision\", \"\", True)\n    app.add_stylesheet(\"rtd_theme_overrides.css\")\n", "path": "docs/conf.py"}]}