docs

vavalomi · Jun 8, 2022 · 45e75e8 · 45e75e8
1 parent 9c46503
commit 45e75e8
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 12 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,6 +12,7 @@
 #
 import os
 import sys
+from datetime import datetime
 
 src = os.path.abspath('..')
 sys.path.insert(0, src)
@@ -26,6 +27,7 @@
 author = about['__author__']
 version = about['__version__']
 release = about['__version__']
+copyright = f"{datetime.now().year} {author}"
 
 
 # -- General configuration ---------------------------------------------------
@@ -73,7 +75,7 @@
     'analytics_id': 'UA-129284684-2',
     'github_button': True,
     'fixed_sidebar': True,
-    'extra_nav_links': {'Survey Solutions Documentation': 'https://support.mysurvey.solutions'}
+    'extra_nav_links': {'Survey Solutions Documentation': 'https://docs.mysurvey.solutions'}
 }
 
 html_static_path = ['_static']

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,7 +14,6 @@ Table of Contents
     ssaw.settings
     ssaw.users
     ssaw.workspaces
-    ssaw.models
 
 Indices and tables
 ==================

diff --git a/docs/ssaw.export.rst b/docs/ssaw.export.rst
@@ -1,7 +1,15 @@
 Export
 ======
+
 .. py:module:: ssaw.export
 
-.. autoclass:: ExportApi()
-  :members:
-  :undoc-members:
+The export module contains methods to find and download an already generated data package, or trigger and manage a new generation job.
+
+
+.. py:class:: ExportApi
+
+  .. automethod:: get_list
+  .. automethod:: get
+  .. automethod:: get_info
+  .. automethod:: start
+  .. automethod:: cancel
diff --git a/docs/ssaw.models.rst b/docs/ssaw.models.rst
diff --git a/ssaw/users.py b/ssaw/users.py
@@ -91,9 +91,17 @@ def viewer(self, username: Optional[str] = None, password: Optional[str] = None)
         return (op + cont).viewer
 
     def lock(self, user_name: Optional[str] = None, user_id: Optional[str] = None):
+        """Lock user given either the username or guid.
+
+        Currently only works for the admin user!
+        """
         self._lock_unlock(lock=True, user_name=user_name, user_id=user_id)
 
     def unlock(self, user_name: Optional[str] = None, user_id: Optional[str] = None):
+        """Unlock user given either the username or guid.
+
+        Currently only works for the admin user!
+        """
         self._lock_unlock(lock=False, user_name=user_name, user_id=user_id)
 
     def _lock_unlock(self, lock: bool, user_name: Optional[str] = None, user_id: Optional[str] = None):
@@ -118,6 +126,10 @@ def _lock_unlock(self, lock: bool, user_name: Optional[str] = None, user_id: Opt
             raise ValueError("either user_name or user_id must be provided")
 
     def change_password(self, password: str, user_name: Optional[str] = None, user_id: Optional[str] = None):
+        """Change password for a user.
+
+        Currently only works for the admin user!
+        """
         if user_name:
             try:
                 user_id = next(self.get_list(fields=["id"], user_name=user_name, take=1)).id