diff --git a/.cruft.json b/.cruft.json index 2272320a..b3a3bea3 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/sunpy/package-template", - "commit": "dd830771f0bb01d5313912e0082f3434715e474a", + "commit": "aec53b81aed2e7e534045e59303d82712fe82fb1", "checkout": null, "context": { "cookiecutter": { diff --git a/dkist/_dev/__init__.py b/dkist/_dev/__init__.py index 72583c08..e38b3a8d 100644 --- a/dkist/_dev/__init__.py +++ b/dkist/_dev/__init__.py @@ -1,5 +1,5 @@ """ -This package contains utilities that are only used when developing drms in a +This package contains utilities that are only used when developing in a copy of the source repository. These files are not installed, and should not be assumed to exist at runtime. diff --git a/docs/conf.py b/docs/conf.py index a918d7da..f44973df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,7 +91,7 @@ ] # Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] +# templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -148,9 +148,6 @@ from dkist_sphinx_theme.conf.theme import * -# 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". # Render inheritance diagrams in SVG graphviz_output_format = "svg" @@ -160,9 +157,23 @@ "-Efontsize=10", "-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif", "-Gfontsize=10", - "-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif" + "-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" + # Use a high-contrast code style from accessible-pygments # Our theme isn't using the correct background colours for code blocks, so this # isn't as high-contrast as it should be.