fix: Fix documentation builds

Resolve import and setup issues that were causing doc builds to fail.

docs/conf.py

@@ -39,6 +39,14 @@ def get_version(*file_paths):
 
 VERSION = get_version('../flashcards', '__init__.py')
 
+# Specify settings module (which will be picked up from the sandbox)
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'flashcards.settings.test')
+
+import django
+
+
+django.setup()
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

flashcards/settings/base.py

@@ -241,3 +241,6 @@ def root(*path_fragments):
 
 # Set up logging for development use (logging to stdout)
 LOGGING = get_logger_config(debug=DEBUG)
+
+# OpenAI API key, to be specified in the private settings file
+OPENAI_API_KEY = ''

flashcards/utils.py

@@ -6,10 +6,9 @@
 """
 
 import openai
+from django.conf import settings
 
-from flashcards.settings.private import OPENAI_API_KEY  # pylint: disable=import-error,no-name-in-module
-
-openai.api_key = OPENAI_API_KEY
+openai.api_key = settings.OPENAI_API_KEY
 
 
 content_prompt = """
@@ -181,19 +180,18 @@
      "content": content_prompt + course_content},
 ]
 
-
-c3 = openai.ChatCompletion.create(
-    model="gpt-3.5-turbo",
-    messages=messages,
-    temperature=1.0,
-)
-
-print(c3['choices'][0]['message']['content'])
-
-# c4 = openai.ChatCompletion.create(
-#     model="gpt-4",
-#     messages=messages,
-#     temperature=1.0,
-# )
-
-# print(c4)
+if openai.api_key:
+    c3 = openai.ChatCompletion.create(
+        model="gpt-3.5-turbo",
+        messages=messages,
+        temperature=1.0,
+    )
+    print(c3['choices'][0]['message']['content'])
+
+    # c4 = openai.ChatCompletion.create(
+    #     model="gpt-4",
+    #     messages=messages,
+    #     temperature=1.0,
+    # )
+
+    # print(c4)