Merge branch 'PYT-916' into 'develop'

PYT-916: Create SDK documentation for the production

See merge request SOLO-band/python-sdk!117

Author: andydemid

docs/Dockerfile

@@ -11,7 +11,7 @@ COPY docs/docs /app/docs
 
 COPY src /app/src
 
-RUN sphinx-build -b html /app/docs /app/syntax_folder
+RUN sphinx-build -a -E -b html /app/docs /app/syntax_folder
 
 FROM public.ecr.aws/rogii/nginx:mainline
 

docs/docs/_static/theme-init.js

@@ -0,0 +1,3 @@
+document.addEventListener("DOMContentLoaded", function () {
+    document.body.dataset.theme = localStorage.getItem("theme") || "auto";
+});

docs/docs/conf.py

@@ -5,7 +5,7 @@
 import os
 
 from custom_stuff.navigation_settings import sidebar_settings
-from custom_stuff.skip_methods import skip_methods
+from custom_stuff.skip_methods import skip_inline_theme_script, skip_methods
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -35,7 +35,7 @@
 html_favicon = '_static/favicon.svg'
 html_logo = '_static/logo.svg'
 html_css_files = ['custom.css']
-html_js_files = ['replace_logo.js']
+html_js_files = ['replace_logo.js', 'theme-init.js']
 html_title = project_name
 html_show_sourcelink = False
 html_show_sphinx = False
@@ -84,5 +84,6 @@
 
 
 def setup(sphinx):
+    sphinx.connect('build-finished', skip_inline_theme_script)
     sphinx.connect('html-page-context', sidebar_settings)
     sphinx.connect('autoapi-skip-member', skip_methods)

docs/docs/custom_stuff/skip_methods.py

@@ -1,3 +1,12 @@
+import os
+import re
+
+THEME_SCRIPT = re.compile(
+    r'<script>\s*document\.body\.dataset\.theme\s*=\s*localStorage\.getItem\("theme"\)\s*\|\|\s*"auto";\s*</script>',
+    re.DOTALL,
+)
+
+
 def skip_methods(app, what, name, obj, skip, options):
     if what in ('method', 'attribute', 'data', 'attributes'):
         method_name = name.rsplit('.', 1)[-1]
@@ -12,3 +21,26 @@ def skip_methods(app, what, name, obj, skip, options):
         return True
 
     return None
+
+
+def skip_inline_theme_script(app, exception):
+    if exception or app.builder.name != 'html':
+        return
+
+    outdir = app.builder.outdir
+
+    for root, _, files in os.walk(outdir):
+        for fname in files:
+            if not fname.endswith('.html'):
+                continue
+
+            path = os.path.join(root, fname)
+
+            with open(path, 'r', encoding='utf-8') as f:
+                text = f.read()
+
+            new_text = THEME_SCRIPT.sub('', text)
+
+            if text != new_text:
+                with open(path, 'w', encoding='utf-8') as f:
+                    f.write(new_text)