From 4f7349d491258587c6f1e55750496d5b76480b39 Mon Sep 17 00:00:00 2001 From: jessicasyu <15913767+jessicasyu@users.noreply.github.com> Date: Tue, 15 Aug 2023 10:55:39 -0400 Subject: [PATCH 1/2] Change autodoc typehints to signature --- docs/_templates/custom_module.rst | 4 ++-- docs/_templates/custom_summary.rst | 4 ++-- docs/conf.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_templates/custom_module.rst b/docs/_templates/custom_module.rst index 9eb45c5..466d2a8 100644 --- a/docs/_templates/custom_module.rst +++ b/docs/_templates/custom_module.rst @@ -1,8 +1,8 @@ {{ objname | escape | underline}} .. automodule:: {{ fullname }} - :members: - :undoc-members: + :members: + :undoc-members: {% block attributes %} {% if attributes %} diff --git a/docs/_templates/custom_summary.rst b/docs/_templates/custom_summary.rst index 6689efc..f579cd9 100644 --- a/docs/_templates/custom_summary.rst +++ b/docs/_templates/custom_summary.rst @@ -1,8 +1,8 @@ {{ fullname | escape | underline}} .. automodule:: {{ fullname }} - :members: - :undoc-members: + :members: + :undoc-members: {% block attributes %} {% if attributes %} diff --git a/docs/conf.py b/docs/conf.py index 4a1d01a..0d69435 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ autodoc_mock_imports = [] # Controls how to represent typehints. -autodoc_typehints = "description" +autodoc_typehints = "signature" # -- Options for HTML output ------------------------------------------------- From 622e82c303279fd2ef6c67b4ddeabc50bbe3ba78 Mon Sep 17 00:00:00 2001 From: jessicasyu <15913767+jessicasyu@users.noreply.github.com> Date: Fri, 18 Aug 2023 16:29:36 -0400 Subject: [PATCH 2/2] Add module docstring --- src/abm_shape_collection/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/abm_shape_collection/__init__.py b/src/abm_shape_collection/__init__.py index af7bca1..079ea75 100644 --- a/src/abm_shape_collection/__init__.py +++ b/src/abm_shape_collection/__init__.py @@ -1,3 +1,5 @@ +"""Tasks for analyzing cell shapes including spherical harmonics and shape modes.""" + from prefect import task from .calculate_shape_stats import calculate_shape_stats