From ef118877c56c48d977d53d8242f6f3797c0c7fe7 Mon Sep 17 00:00:00 2001
From: Remco Tukker <remco.tukker@geant.org>
Date: Thu, 27 Apr 2023 23:44:36 +0200
Subject: [PATCH] add the publishers to the sphinx docs
---
compendium_v2/publishers/survey_publisher_2022.py | 8 ++++++++
compendium_v2/publishers/survey_publisher_v1.py | 9 +++++++++
docs/source/index.rst | 1 +
docs/source/publishers.rst | 14 ++++++++++++++
4 files changed, 32 insertions(+)
create mode 100644 docs/source/publishers.rst
diff --git a/compendium_v2/publishers/survey_publisher_2022.py b/compendium_v2/publishers/survey_publisher_2022.py
index f8967ba2..710c899d 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 c5d5070f..d07f1f42 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 11a4f0a3..8a97f8f6 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 00000000..011de02f
--- /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:
+
--
GitLab