Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add module docstrings #56

Merged
merged 2 commits into from
Aug 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/_templates/custom_module.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{ objname | escape | underline}}

.. automodule:: {{ fullname }}
:members:
:undoc-members:
:members:
:undoc-members:

{% block attributes %}
{% if attributes %}
Expand Down
4 changes: 2 additions & 2 deletions docs/_templates/custom_summary.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{ fullname | escape | underline}}

.. automodule:: {{ fullname }}
:members:
:undoc-members:
:members:
:undoc-members:

{% block attributes %}
{% if attributes %}
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
autodoc_mock_imports = []

# Controls how to represent typehints.
autodoc_typehints = "description"
autodoc_typehints = "signature"

# -- Options for HTML output -------------------------------------------------

Expand Down
2 changes: 2 additions & 0 deletions src/container_collection/batch/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tasks for working with AWS Batch."""

from prefect import task

from .check_batch_job import check_batch_job
Expand Down
2 changes: 2 additions & 0 deletions src/container_collection/docker/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tasks for working with Docker."""

from prefect import task

from .check_docker_job import check_docker_job
Expand Down
2 changes: 2 additions & 0 deletions src/container_collection/fargate/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tasks for working with AWS ECS Fargate."""

from prefect import task

from .check_fargate_task import check_fargate_task
Expand Down
2 changes: 2 additions & 0 deletions src/container_collection/manifest/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tasks for working with manifest files."""

from prefect import task

from .filter_manifest_files import filter_manifest_files
Expand Down
2 changes: 2 additions & 0 deletions src/container_collection/template/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tasks for working with template files."""

from prefect import task

from .generate_input_contents import generate_input_contents
Expand Down