# Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config import os import datetime from pathlib import Path from sunpy_sphinx_theme import PNG_ICON from packaging.version import Version # -- Project information ----------------------------------------------------- # The full version, including alpha/beta/rc tags from drms import __version__ _version = Version(__version__) version = release = str(_version) # Avoid "post" appearing in version string in rendered docs if _version.is_postrelease: version = release = _version.base_version # Avoid long githashes in rendered Sphinx docs elif _version.is_devrelease: version = release = f"{_version.base_version}.dev{_version.dev}" is_development = _version.is_devrelease is_release = not (_version.is_prerelease or _version.is_devrelease) project = "drms" author = "The SunPy Community" copyright = f"{datetime.datetime.now().year}, {author}" # noqa: A001 # -- General configuration --------------------------------------------------- # Wrap large function/method signatures maximum_signature_line_length = 80 # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named "sphinx.ext.*") or your custom # ones. extensions = [ # TODO: Re-enable this, it was failing the doc build # "hoverxref.extension", "sphinx_copybutton", "sphinx_gallery.gen_gallery", "sphinx.ext.autodoc", "sphinx.ext.coverage", "sphinx.ext.doctest", "sphinx.ext.inheritance_diagram", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.mathjax", "sphinx_automodapi.automodapi", "sphinx_automodapi.smart_resolver", "sphinx_changelog", ] # Add any paths that contain templates here, relative to this directory. # templates_path = ["_templates"] # 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. automodapi_toctreedirnm = "generated/api" exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The suffix(es) of source filenames. source_suffix = {".rst": "restructuredtext"} # The master toctree document. master_doc = "index" # Treat everything in single ` as a Python reference. default_role = "py:obj" # -- Options for intersphinx extension --------------------------------------- intersphinx_mapping = { "python": ( "https://docs.python.org/3/", (None, "http://www.astropy.org/astropy-data/intersphinx/python3.inv"), ), "numpy": ( "https://numpy.org/doc/stable/", (None, "http://www.astropy.org/astropy-data/intersphinx/numpy.inv"), ), "scipy": ( "https://docs.scipy.org/doc/scipy/reference/", (None, "http://www.astropy.org/astropy-data/intersphinx/scipy.inv"), ), "matplotlib": ("https://matplotlib.org/stable", None), "astropy": ("https://docs.astropy.org/en/stable/", None), "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), "sunpy": ("https://docs.sunpy.org/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" 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", ] # 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 = ["_static"] # 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 ---------------------------------------------------------- # JSOC email os env # see https://github.com/sunpy/sunpy/wiki/Home:-JSOC os.environ["JSOC_EMAIL"] = "jsoc@sunpy.org" # -- Options for hoverxref ----------------------------------------------------- if os.environ.get("READTHEDOCS"): hoverxref_api_host = "https://readthedocs.org" if os.environ.get("PROXIED_API_ENDPOINT"): # Use the proxied API endpoint # - A RTD thing to avoid a CSRF block when docs are using a # custom domain hoverxref_api_host = "/_" hoverxref_tooltip_maxwidth = 600 # RTD main window is 696px hoverxref_auto_ref = True hoverxref_mathjax = True hoverxref_domains = ["py"] hoverxref_role_types = { # roles with py domain "attr": "tooltip", "class": "tooltip", "const": "tooltip", "data": "tooltip", "exc": "tooltip", "func": "tooltip", "meth": "tooltip", "mod": "tooltip", "obj": "tooltip", # roles with std domain "confval": "tooltip", "hoverxref": "tooltip", "ref": "tooltip", "term": "tooltip", } # -- 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 # -- Sphinx Gallery ------------------------------------------------------------ sphinx_gallery_conf = { "backreferences_dir": Path("generated") / "modules", "filename_pattern": "^((?!skip_).)*$", "examples_dirs": Path("..") / "examples", "within_subsection_order": "ExampleTitleSortKey", "gallery_dirs": Path("generated") / "gallery", "default_thumb_file": PNG_ICON, "abort_on_example_error": False, "plot_gallery": "True", "remove_config_comments": True, "doc_module": ("sunpy"), "only_warn_on_example_error": True, "matplotlib_animations": True, }