Update conf.py

docs/conf.py

@@ -4,14 +4,15 @@
 # full list see the documentation:
 # http://www.sphinx-doc.org/en/master/config
 
-# -- Project information -----------------------------------------------------
 import datetime
 from pathlib import Path
 
 from packaging.version import Version
+
 from sunpy_sphinx_theme import PNG_ICON
 
 # -- Project information -----------------------------------------------------
+
 # The full version, including alpha/beta/rc tags
 from sunpy_soar import __version__
 
@@ -31,6 +32,7 @@
 author = "The SunPy Community"
 
 # -- General configuration ---------------------------------------------------
+
 extensions = [
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.plot_directive",
@@ -48,16 +50,27 @@
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
 ]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ["_templates"]  # NOQA: ERA001
+
+# 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 = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
 source_suffix = ".rst"
+
+# The master toctree document.
 master_doc = "index"
-napoleon_use_rtype = False
-napoleon_google_docstring = False
 
 # Treat everything in single ` as a Python reference.
 default_role = "py:obj"
 
 # -- Options for intersphinx extension ---------------------------------------
+
 intersphinx_mapping = {
     "python": (
         "https://docs.python.org/3/",
@@ -80,8 +93,12 @@
     "parfive": ("https://parfive.readthedocs.io/en/stable/", None),
 }
 
-<<<<<<<
-=======
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sunpy"
+
 # Render inheritance diagrams in SVG
 graphviz_output_format = "svg"
 
@@ -97,23 +114,22 @@
 # 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".
->>>>>>>
-# -- Options for HTML output -------------------------------------------------
-html_theme = "sunpy"
-graphviz_output_format = "svg"
-graphviz_dot_args = [
-    "-Nfontsize=10",
-    "-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif",
-    "-Efontsize=10",
-    "-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif",
-    "-Gfontsize=10",
-    "-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif",
-]
+# html_static_path = ["_static"]  # NOQA: ERA001
 
-# -- Options for sphinx-copybutton ---------------------------------------------
-# Python Repl + continuation, Bash, ipython and qtconsole + continuation, jupyter-console + continuation
-copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
-copybutton_prompt_is_regexp = True
+# By default, when rendering docstrings for classes, sphinx.ext.autodoc will
+# make docs with the class-level docstring and the class-method docstrings,
+# but not the __init__ docstring, which often contains the parameters to
+# class constructors across the scientific Python ecosystem. The option below
+# will append the __init__ docstring to the class-level docstring when rendering
+# the docs. For more options, see:
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content
+autoclass_content = "both"
+
+# -- Other options ----------------------------------------------------------
+
+napoleon_use_rtype = False
+
+napoleon_google_docstring = False
 
 # Enable nitpicky mode, which forces links to be non-broken
 nitpicky = True
@@ -126,8 +142,15 @@
         dtype, target = line.split(None, 1)
         target = target.strip()
         nitpick_ignore.append((dtype, target))
+
+# -- Options for sphinx-copybutton ---------------------------------------------
+
+# Python Repl + continuation, Bash, ipython and qtconsole + continuation, jupyter-console + continuation
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
 
 # -- Options for the Sphinx gallery -------------------------------------------
+
 sphinx_gallery_conf = {
     "backreferences_dir": Path("generated") / "modules",
     "filename_pattern": "^((?!skip_).)*$",