We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Fix definition of `version` and `release` in docs conf.py
Update the the definition of sphinx project info `version` and `release`, such that they are automatically updated with package versions.  A good example of how to do this can be seen in Astorpy's `conf.py` [here](https://github.com/astropy/astropy/blob/f6a9846b5e7c054878080ba49212a961bab2ff78/docs/conf.py#L111-L114).

```python
# The full version, including alpha/beta/rc tags.
release = pkg_resources.get_distribution(project).version
# The short X.Y version.
version = '.'.join(release.split('.')[:2])
```

This method does create a documentation dependency on `setuptools`.

--- 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 sys.path.insert(0, os.path.abspath('..'))
25 
26 # -- General configuration ------------------------------------------------
27 
28 # If your documentation needs a minimal Sphinx version, state it here.
29 #
30 # needs_sphinx = '1.0'
31 
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # ones.
35 extensions = [
36     'sphinx.ext.autodoc',
37     'sphinx.ext.intersphinx',
38     'sphinx.ext.graphviz',
39     'sphinx.ext.mathjax',
40     'sphinx.ext.napoleon',
41     'sphinx_automodapi.automodapi',
42     'sphinx_automodapi.smart_resolver',
43     'sphinx_gallery.gen_gallery',
44 ]
45 
46 
47 intersphinx_mapping = {
48     'python': ('https://docs.python.org/3', None),
49     'numpy': ('https://docs.scipy.org/doc/numpy', None),
50     'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
51     'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
52     'astropy': ('http://docs.astropy.org/en/stable/', None)}
53 # Add any paths that contain templates here, relative to this directory.
54 templates_path = ['_templates']
55 
56 # The suffix(es) of source filenames.
57 # You can specify multiple suffix as a list of string:
58 #
59 # source_suffix = ['.rst', '.md']
60 source_suffix = '.rst'
61 
62 # The master toctree document.
63 master_doc = 'index'
64 
65 # General information about the project.
66 project = 'PlasmaPy'
67 copyright = '2015-2019, PlasmaPy Community'
68 author = 'PlasmaPy Community'
69 
70 # The version info for the project you're documenting, acts as replacement for
71 # |version| and |release|, also used in various other places throughout the
72 # built documents.
73 #
74 # The short X.Y version.
75 version = '0.2'
76 # The full version, including alpha/beta/rc tags.
77 release = '0.2.0'
78 
79 # The language for content autogenerated by Sphinx. Refer to documentation
80 # for a list of supported languages.
81 #
82 # This is also used if you do content translation via gettext catalogs.
83 # Usually you set "language" from the command line for these cases.
84 language = None
85 
86 # List of patterns, relative to source directory, that match files and
87 # directories to ignore when looking for source files.
88 # This patterns also effect to html_static_path and html_extra_path
89 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
90 
91 # The name of the Pygments (syntax highlighting) style to use.
92 pygments_style = 'sphinx'
93 
94 # If true, `todo` and `todoList` produce output, else they produce nothing.
95 todo_include_todos = False
96 
97 default_role = 'obj'
98 
99 # -- Options for HTML output ----------------------------------------------
100 
101 # The theme to use for HTML and HTML Help pages.  See the documentation for
102 # a list of builtin themes.
103 #
104 # html_theme = 'alabaster'
105 # html_theme = 'traditional'
106 # html_theme = 'agogo'
107 html_theme = "sphinx_rtd_theme"
108 
109 # Theme options are theme-specific and customize the look and feel of a theme
110 # further.  For a list of options available for each theme, see the
111 # documentation.
112 #
113 # html_theme_options = {}
114 
115 # Add any paths that contain custom static files (such as style sheets) here,
116 # relative to this directory. They are copied after the builtin static files,
117 # so a file named "default.css" will overwrite the builtin "default.css".
118 # html_static_path = ['_static']
119 
120 
121 # -- Options for HTMLHelp output ------------------------------------------
122 
123 # Output file base name for HTML help builder.
124 htmlhelp_basename = 'PlasmaPydoc'
125 
126 
127 # -- Options for LaTeX output ---------------------------------------------
128 
129 latex_elements = {
130     # The paper size ('letterpaper' or 'a4paper').
131     #
132     # 'papersize': 'letterpaper',
133 
134     # The font size ('10pt', '11pt' or '12pt').
135     #
136     # 'pointsize': '10pt',
137 
138     # Additional stuff for the LaTeX preamble.
139     #
140     # 'preamble': '',
141 
142     # Latex figure (float) alignment
143     #
144     # 'figure_align': 'htbp',
145 }
146 
147 # Grouping the document tree into LaTeX files. List of tuples
148 # (source start file, target name, title,
149 #  author, documentclass [howto, manual, or own class]).
150 latex_documents = [
151     (master_doc, 'PlasmaPy.tex', 'PlasmaPy Documentation',
152      'PlasmaPy Community', 'manual'),
153 ]
154 
155 
156 # -- Options for manual page output ---------------------------------------
157 
158 # One entry per manual page. List of tuples
159 # (source start file, name, description, authors, manual section).
160 man_pages = [
161     (master_doc, 'plasmapy', 'PlasmaPy Documentation',
162      [author], 1)
163 ]
164 
165 
166 # -- Options for Texinfo output -------------------------------------------
167 
168 # Grouping the document tree into Texinfo files. List of tuples
169 # (source start file, target name, title, author,
170 #  dir menu entry, description, category)
171 texinfo_documents = [
172     (master_doc, 'PlasmaPy', 'PlasmaPy Documentation',
173      author, 'PlasmaPy', 'Python package for plasma physics',
174      'Miscellaneous'),
175 ]
176 
177 html_favicon = "./_static/icon.ico"
178 
179 # -- Options for Sphinx Gallery -----------------
180 
181 # Patch sphinx_gallery.binder.gen_binder_rst so as to point to .py file in repository
182 # Original code as per sphinx_gallery, under the BSD 3-Clause license
183 
184 import sphinx_gallery.binder
185 def patched_gen_binder_rst(fpath, binder_conf, gallery_conf):
186     """Generate the RST + link for the Binder badge.
187     Parameters
188     ----------
189     fpath: str
190         The path to the `.py` file for which a Binder badge will be generated.
191     binder_conf: dict or None
192         If a dictionary it must have the following keys:
193         'binderhub_url'
194             The URL of the BinderHub instance that's running a Binder service.
195         'org'
196             The GitHub organization to which the documentation will be pushed.
197         'repo'
198             The GitHub repository to which the documentation will be pushed.
199         'branch'
200             The Git branch on which the documentation exists (e.g., gh-pages).
201         'dependencies'
202             A list of paths to dependency files that match the Binderspec.
203     Returns
204     -------
205     rst : str
206         The reStructuredText for the Binder badge that links to this file.
207     """
208     binder_conf = sphinx_gallery.binder.check_binder_conf(binder_conf)
209     binder_url = sphinx_gallery.binder.gen_binder_url(fpath, binder_conf, gallery_conf)
210     binder_url = binder_url.replace(gallery_conf['gallery_dirs'] + os.path.sep, "").replace("ipynb", "py")
211 
212     rst = (
213         "\n"
214         "  .. container:: binder-badge\n\n"
215         "    .. image:: https://mybinder.org/badge_logo.svg\n"
216         "      :target: {}\n"
217         "      :width: 150 px\n").format(binder_url)
218     return rst
219 sphinx_gallery.binder.gen_binder_rst = patched_gen_binder_rst
220 
221 sphinx_gallery_conf = {
222     # path to your examples scripts
223     'examples_dirs': '../plasmapy/examples',
224     # path where to save gallery generated examples
225     'backreferences_dir': 'gen_modules/backreferences',
226     'gallery_dirs': 'auto_examples',
227     'binder': {
228         'org': 'PlasmaPy',
229         'repo': 'PlasmaPy',
230         'branch': 'master',
231         'binderhub_url': 'https://mybinder.org',
232         'dependencies': ['../binder/requirements.txt'],
233         'notebooks_dir': 'plasmapy/examples',
234     }
235 }
236
```
--- 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
@@ -64,17 +64,22 @@
 
 # General information about the project.
 project = 'PlasmaPy'
-copyright = '2015-2019, PlasmaPy Community'
+copyright = '2015-2020, PlasmaPy Community'
 author = 'PlasmaPy Community'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.2.0'
+#  Note: If plasmapy.__version__ can not be defined then it is set to 'unknown'.
+#        However, release needs to be a semantic style version number, so set
+#        the 'unknown' case to ''.
+from plasmapy import __version__ as release
+release = '' if release == 'unknown' else release
+# The short X.Y version.
+version = '.'.join(release.split('.')[:2])
+
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -64,17 +64,22 @@\n \n # General information about the project.\n project = 'PlasmaPy'\n-copyright = '2015-2019, PlasmaPy Community'\n+copyright = '2015-2020, PlasmaPy Community'\n author = 'PlasmaPy Community'\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 short X.Y version.\n-version = '0.2'\n # The full version, including alpha/beta/rc tags.\n-release = '0.2.0'\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 ''.\n+from plasmapy import __version__ as release\n+release = '' if release == 'unknown' else release\n+# The short X.Y version.\n+version = '.'.join(release.split('.')[:2])\n+\n \n # The language for content autogenerated by Sphinx. Refer to documentation\n # for a list of supported languages.\n", "issue": "Fix definition of `version` and `release` in docs conf.py\nUpdate the the definition of sphinx project info `version` and `release`, such that they are automatically updated with package versions.  A good example of how to do this can be seen in Astorpy's `conf.py` [here](https://github.com/astropy/astropy/blob/f6a9846b5e7c054878080ba49212a961bab2ff78/docs/conf.py#L111-L114).\r\n\r\n```python\r\n# The full version, including alpha/beta/rc tags.\r\nrelease = pkg_resources.get_distribution(project).version\r\n# The short X.Y version.\r\nversion = '.'.join(release.split('.')[:2])\r\n```\r\n\r\nThis method does create a documentation dependency on `setuptools`.\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\nsys.path.insert(0, os.path.abspath('..'))\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    'sphinx_gallery.gen_gallery',\n]\n\n\nintersphinx_mapping = {\n    'python': ('https://docs.python.org/3', None),\n    'numpy': ('https://docs.scipy.org/doc/numpy', 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# 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'\ncopyright = '2015-2019, PlasmaPy Community'\nauthor = 'PlasmaPy Community'\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 short X.Y version.\nversion = '0.2'\n# The full version, including alpha/beta/rc tags.\nrelease = '0.2.0'\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#\n# html_theme_options = {}\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\".\n# html_static_path = ['_static']\n\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    #\n    # 'papersize': 'letterpaper',\n\n    # The font size ('10pt', '11pt' or '12pt').\n    #\n    # 'pointsize': '10pt',\n\n    # Additional stuff for the LaTeX preamble.\n    #\n    # 'preamble': '',\n\n    # Latex figure (float) alignment\n    #\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    (master_doc, 'PlasmaPy.tex', 'PlasmaPy Documentation',\n     'PlasmaPy Community', 'manual'),\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 = [\n    (master_doc, 'plasmapy', 'PlasmaPy Documentation',\n     [author], 1)\n]\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    (master_doc, 'PlasmaPy', 'PlasmaPy Documentation',\n     author, 'PlasmaPy', 'Python package for plasma physics',\n     'Miscellaneous'),\n]\n\nhtml_favicon = \"./_static/icon.ico\"\n\n# -- Options for Sphinx Gallery -----------------\n\n# Patch sphinx_gallery.binder.gen_binder_rst so as to point to .py file in repository\n# Original code as per sphinx_gallery, under the BSD 3-Clause license\n\nimport sphinx_gallery.binder\ndef patched_gen_binder_rst(fpath, binder_conf, gallery_conf):\n    \"\"\"Generate the RST + link for the Binder badge.\n    Parameters\n    ----------\n    fpath: str\n        The path to the `.py` file for which a Binder badge will be generated.\n    binder_conf: dict or None\n        If a dictionary it must have the following keys:\n        'binderhub_url'\n            The URL of the BinderHub instance that's running a Binder service.\n        'org'\n            The GitHub organization to which the documentation will be pushed.\n        'repo'\n            The GitHub repository to which the documentation will be pushed.\n        'branch'\n            The Git branch on which the documentation exists (e.g., gh-pages).\n        'dependencies'\n            A list of paths to dependency files that match the Binderspec.\n    Returns\n    -------\n    rst : str\n        The reStructuredText for the Binder badge that links to this file.\n    \"\"\"\n    binder_conf = sphinx_gallery.binder.check_binder_conf(binder_conf)\n    binder_url = sphinx_gallery.binder.gen_binder_url(fpath, binder_conf, gallery_conf)\n    binder_url = binder_url.replace(gallery_conf['gallery_dirs'] + os.path.sep, \"\").replace(\"ipynb\", \"py\")\n\n    rst = (\n        \"\\n\"\n        \"  .. container:: binder-badge\\n\\n\"\n        \"    .. image:: https://mybinder.org/badge_logo.svg\\n\"\n        \"      :target: {}\\n\"\n        \"      :width: 150 px\\n\").format(binder_url)\n    return rst\nsphinx_gallery.binder.gen_binder_rst = patched_gen_binder_rst\n\nsphinx_gallery_conf = {\n    # path to your examples scripts\n    'examples_dirs': '../plasmapy/examples',\n    # path where to save gallery generated examples\n    'backreferences_dir': 'gen_modules/backreferences',\n    'gallery_dirs': 'auto_examples',\n    'binder': {\n        'org': 'PlasmaPy',\n        'repo': 'PlasmaPy',\n        'branch': 'master',\n        'binderhub_url': 'https://mybinder.org',\n        'dependencies': ['../binder/requirements.txt'],\n        'notebooks_dir': 'plasmapy/examples',\n    }\n}\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\nsys.path.insert(0, os.path.abspath('..'))\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    'sphinx_gallery.gen_gallery',\n]\n\n\nintersphinx_mapping = {\n    'python': ('https://docs.python.org/3', None),\n    'numpy': ('https://docs.scipy.org/doc/numpy', 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# 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'\ncopyright = '2015-2020, PlasmaPy Community'\nauthor = 'PlasmaPy Community'\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 ''.\nfrom plasmapy import __version__ as release\nrelease = '' if release == 'unknown' else release\n# The short X.Y version.\nversion = '.'.join(release.split('.')[:2])\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#\n# html_theme_options = {}\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\".\n# html_static_path = ['_static']\n\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    #\n    # 'papersize': 'letterpaper',\n\n    # The font size ('10pt', '11pt' or '12pt').\n    #\n    # 'pointsize': '10pt',\n\n    # Additional stuff for the LaTeX preamble.\n    #\n    # 'preamble': '',\n\n    # Latex figure (float) alignment\n    #\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    (master_doc, 'PlasmaPy.tex', 'PlasmaPy Documentation',\n     'PlasmaPy Community', 'manual'),\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 = [\n    (master_doc, 'plasmapy', 'PlasmaPy Documentation',\n     [author], 1)\n]\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    (master_doc, 'PlasmaPy', 'PlasmaPy Documentation',\n     author, 'PlasmaPy', 'Python package for plasma physics',\n     'Miscellaneous'),\n]\n\nhtml_favicon = \"./_static/icon.ico\"\n\n# -- Options for Sphinx Gallery -----------------\n\n# Patch sphinx_gallery.binder.gen_binder_rst so as to point to .py file in repository\n# Original code as per sphinx_gallery, under the BSD 3-Clause license\n\nimport sphinx_gallery.binder\ndef patched_gen_binder_rst(fpath, binder_conf, gallery_conf):\n    \"\"\"Generate the RST + link for the Binder badge.\n    Parameters\n    ----------\n    fpath: str\n        The path to the `.py` file for which a Binder badge will be generated.\n    binder_conf: dict or None\n        If a dictionary it must have the following keys:\n        'binderhub_url'\n            The URL of the BinderHub instance that's running a Binder service.\n        'org'\n            The GitHub organization to which the documentation will be pushed.\n        'repo'\n            The GitHub repository to which the documentation will be pushed.\n        'branch'\n            The Git branch on which the documentation exists (e.g., gh-pages).\n        'dependencies'\n            A list of paths to dependency files that match the Binderspec.\n    Returns\n    -------\n    rst : str\n        The reStructuredText for the Binder badge that links to this file.\n    \"\"\"\n    binder_conf = sphinx_gallery.binder.check_binder_conf(binder_conf)\n    binder_url = sphinx_gallery.binder.gen_binder_url(fpath, binder_conf, gallery_conf)\n    binder_url = binder_url.replace(gallery_conf['gallery_dirs'] + os.path.sep, \"\").replace(\"ipynb\", \"py\")\n\n    rst = (\n        \"\\n\"\n        \"  .. container:: binder-badge\\n\\n\"\n        \"    .. image:: https://mybinder.org/badge_logo.svg\\n\"\n        \"      :target: {}\\n\"\n        \"      :width: 150 px\\n\").format(binder_url)\n    return rst\nsphinx_gallery.binder.gen_binder_rst = patched_gen_binder_rst\n\nsphinx_gallery_conf = {\n    # path to your examples scripts\n    'examples_dirs': '../plasmapy/examples',\n    # path where to save gallery generated examples\n    'backreferences_dir': 'gen_modules/backreferences',\n    'gallery_dirs': 'auto_examples',\n    'binder': {\n        'org': 'PlasmaPy',\n        'repo': 'PlasmaPy',\n        'branch': 'master',\n        'binderhub_url': 'https://mybinder.org',\n        'dependencies': ['../binder/requirements.txt'],\n        'notebooks_dir': 'plasmapy/examples',\n    }\n}\n", "path": "docs/conf.py"}]}