diff --git a/compendium_v2/publishers/survey_publisher_2022.py b/compendium_v2/publishers/survey_publisher_2022.py index f8967ba2107221978f7c6f60387c1cf03f83d639..710c899d4378a7e5a9bd76246789176fb2d57e54 100644 --- a/compendium_v2/publishers/survey_publisher_2022.py +++ b/compendium_v2/publishers/survey_publisher_2022.py @@ -1,3 +1,11 @@ +""" +survey_publisher_2022 +========================= + +This module loads the survey data from 2022 from the survey database. +Registered as click cli command when installing compendium-v2. + +""" import logging import click import enum diff --git a/compendium_v2/publishers/survey_publisher_v1.py b/compendium_v2/publishers/survey_publisher_v1.py index c5d5070ff3295113f73932148def0b8edd00ad9b..d07f1f42f32f0cf9315faa3e0d0c08c7dfab4792 100644 --- a/compendium_v2/publishers/survey_publisher_v1.py +++ b/compendium_v2/publishers/survey_publisher_v1.py @@ -1,3 +1,12 @@ +""" +survey_publisher_v1 +========================= + +This module loads the survey data from before 2022 from and excel file. +Missing info is filled in from the survey db for some questions. +Registered as click cli command when installing compendium-v2. + +""" import logging import math import click diff --git a/docs/source/index.rst b/docs/source/index.rst index 11a4f0a350ea8385478ed15053622c3051f13aaa..8a97f8f6cd34c7c6df1d3997d21b46fc04f798c9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,3 +11,4 @@ a React web application that consumes and renders the json data. api development + publishers diff --git a/docs/source/publishers.rst b/docs/source/publishers.rst new file mode 100644 index 0000000000000000000000000000000000000000..011de02fd88a431ec847dc8c98c68a221e2a864c --- /dev/null +++ b/docs/source/publishers.rst @@ -0,0 +1,14 @@ +.. api intro + +Publishers +=============== + + +.. contents:: :local: + +.. automodule:: compendium_v2.publishers.survey_publisher_v1 + :members: + +.. automodule:: compendium_v2.publishers.survey_publisher_2022 + :members: +