From b154fe4498ff18e8f8eeb4d137a4034328e3da58 Mon Sep 17 00:00:00 2001 From: Jacob Reinhold Date: Mon, 16 Aug 2021 16:40:16 -0400 Subject: [PATCH] fix docs --- README.rst | 4 ++++ docs/lesion_metrics.rst | 16 ++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.rst b/README.rst index 3fcccb1..b42cdb2 100644 --- a/README.rst +++ b/README.rst @@ -31,6 +31,10 @@ To install the dependencies of the CLI, install with:: pip install "lesion-metrics[cli]" +To install the dependencies for total lesion burden/volume computation (see ``lesion_metrics.volume``), install with:: + + pip install "lesion-metrics[volume]" + You can also download the source and run:: python setup.py install diff --git a/docs/lesion_metrics.rst b/docs/lesion_metrics.rst index 93c73aa..1865d97 100644 --- a/docs/lesion_metrics.rst +++ b/docs/lesion_metrics.rst @@ -28,6 +28,22 @@ lesion\_metrics.types module :undoc-members: :show-inheritance: +lesion\_metrics.utils module +---------------------------- + +.. automodule:: lesion_metrics.utils + :members: + :undoc-members: + :show-inheritance: + +lesion\_metrics.volume module +----------------------------- + +.. automodule:: lesion_metrics.volume + :members: + :undoc-members: + :show-inheritance: + Module contents ---------------