Merge pull request #360 from dstansby/docfixes

Misc doc fixes

doc/source/conf.py

@@ -23,16 +23,9 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pfsspy'
-copyright = '2018-2021 pfsspy contributors'
+copyright = '2018-2022 pfsspy contributors'
 author = 'pfsspy contributors'
 
-
-# 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.
@@ -64,31 +57,9 @@
     'reference_url': {'sphinx_gallery': None}
 }
 
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
 # The master toctree document.
 master_doc = 'index'
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# 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
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
 
@@ -99,29 +70,6 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
-# html_theme = 'sunpy'
-# html_sidebars = {'**': ['docsidebar.html']}
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
-# html_sidebars = {}
 
 default_role = 'py:obj'
 
@@ -130,89 +78,18 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pfsspydoc'
 
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'pfsspy.tex', 'pfsspy Documentation',
-     'pfsspy contributors', 'manual'),
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pfsspy', 'pfsspy Documentation',
-     [author], 1)
-]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'pfsspy', 'pfsspy Documentation',
-     author, 'pfsspy', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-
-# -- Options for Epub output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
 os.environ["JSOC_EMAIL"] = 'jsoc@sunpy.org'
 
-
-# -- Extension configuration -------------------------------------------------
-
-# -- Options for intersphinx extension ---------------------------------------
+# -- Options for intersphinx extension
+# ------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/3/': None,
                        'https://docs.astropy.org/en/stable': None,
                        'https://docs.sunpy.org/en/stable': None,
                        'https://numpy.org/doc/stable': None,
                        'https://streamtracer.readthedocs.io/en/stable': None,
-                       'https://docs.scipy.org/doc/scipy/reference': None,
+                       'https://docs.scipy.org/doc/scipy/': None,
                        'https://reproject.readthedocs.io/en/stable/': None}
 
 nitpicky = True

doc/source/project_status.rst

@@ -7,10 +7,12 @@ Most of the package was written by myself, with some community contributions.
 I am the sole maintainer of the package, which is currently feature complete (providing a spherical PFSS solver in Python that integrates well with the SunPy package ecosystem).
 
 Going forward the only changes to the package will be:
+
 - Fixing `identified bugs <https://github.com/dstansby/pfsspy/issues?q=is%3Aopen+is%3Aissue+label%3ABug>`__
 - Adding tightly scoped `new features <https://github.com/dstansby/pfsspy/issues?q=is%3Aopen+is%3Aissue+label%3AEnhancement>`__ to improve usability or integrate better with other SunPy packages.
 - Improving the documentation.
 - Retaining compatibility with future versions of the package dependencies (e.g. sunpy, Matplotlib...)
+
 I intend to remain the sole maintainer of the package, but since I'm not currently active in solar physics research don't have lots of time to work on pfsspy.
 As a priority I will maintain the issue list with well scoped pieces of work that others can contribute to fixing.
 

pfsspy/output.py

@@ -428,11 +428,11 @@ def get_bvec(self, coords, out_type="spherical"):
 
         Parameters
         ----------
-        coords : `astropy.SkyCoord`
+        coords : `astropy.coordinates.SkyCoord`
             An arbitary point or set of points (length N >= 1) in the PFSS
             model domain (1Rs < r < Rss).
 
-        out_type : str, optional
+        out_type : str
             Takes values 'spherical' (default) or 'cartesian' and specifies
             whether the output vector is in spherical coordinates
             (B_r, B_theta, B_phi) or cartesian (B_x, B_y, B_z).