Add module docstrings (#49)

* Change autodoc typehints to signature * Add module docstrings
bagherilab · Aug 17, 2023 · 2bd2046 · 2bd2046
1 parent 99e7655
commit 2bd2046
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git 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
@@ -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
@@ -62,7 +62,7 @@
 autodoc_mock_imports = []
 
 # Controls how to represent typehints.
-autodoc_typehints = "description"
+autodoc_typehints = "signature"
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/src/arcade_collection/input/__init__.py b/src/arcade_collection/input/__init__.py
@@ -1,3 +1,5 @@
+"""Tasks for generating input files for ARCADE."""
+
 from prefect import task
 
 from .convert_to_cells_file import convert_to_cells_file

diff --git a/src/arcade_collection/output/__init__.py b/src/arcade_collection/output/__init__.py
@@ -1,3 +1,5 @@
+"""Tasks for processing output files from ARCADE."""
+
 from prefect import task
 
 from .convert_model_units import convert_model_units