follow sphinx convention

Author: dojutsu-user

sphinx_search/extension.py

@@ -3,12 +3,12 @@
 from sphinx.util.fileutil import copy_asset
 
 
-CUSTOM_ASSETS_FILES = {
-    'MINIFIED': [
+ASSETS_FILES = {
+    'minified': [
         os.path.join('js', 'rtd_sphinx_search.min.js'),
         os.path.join('css', 'rtd_sphinx_search.min.css'),
     ],
-    'UN_MINIFIED': [
+    'un-minified': [
         os.path.join('js', 'rtd_sphinx_search.js'),
         os.path.join('css', 'rtd_sphinx_search.css'),
     ]
@@ -17,16 +17,22 @@
 
 def copy_asset_files(app, exception):
     if exception is None:  # build succeeded
-        files = CUSTOM_ASSETS_FILES['MINIFIED'] + CUSTOM_ASSETS_FILES['UN_MINIFIED']
+        files = ASSETS_FILES['minified'] + ASSETS_FILES['un-minified']
         for file in files:
             path = os.path.join(os.path.dirname(__file__), '_static', file)
             copy_asset(path, os.path.join(app.outdir, '_static', file.split('.')[-1]))
 
 
 def inject_static_files(app):
-    """Inject correct CSS and JS files based on the value of ``RTD_SPHINX_SEARCH_FILE_TYPE``.""" 
-    file_type = app.config.RTD_SPHINX_SEARCH_FILE_TYPE
-    files = CUSTOM_ASSETS_FILES[file_type]
+    """Inject correct CSS and JS files based on the value of ``RTD_SPHINX_SEARCH_FILE_TYPE``."""
+    file_type = app.config.rtd_sphinx_search_file_type
+    expected_file_type = ASSETS_FILES.keys()
+
+    assert (
+        file_type in expected_file_type
+    ), f'"{file_type}" file type is not supported.'
+
+    files = ASSETS_FILES[file_type]
 
     for file in files:
         if file.endswith('.js'):
@@ -37,7 +43,7 @@ def inject_static_files(app):
 
 def setup(app):
 
-    app.add_config_value('RTD_SPHINX_SEARCH_FILE_TYPE', 'UN_MINIFIED', 'html')
+    app.add_config_value('rtd_sphinx_search_file_type', 'un-minified', 'html')
 
     app.connect('builder-inited', inject_static_files)
     app.connect('build-finished', copy_asset_files)

tests/test_extension.py

@@ -6,7 +6,7 @@
 import pytest
 
 from tests import TEST_DOCS_SRC
-from sphinx_search.extension import CUSTOM_ASSETS_FILES
+from sphinx_search.extension import ASSETS_FILES
 
 
 @pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
@@ -15,7 +15,7 @@ def test_static_files_exists(app, status, warning):
     app.build()
     path = app.outdir
 
-    static_files = CUSTOM_ASSETS_FILES['MINIFIED'] + CUSTOM_ASSETS_FILES['UN_MINIFIED']
+    static_files = ASSETS_FILES['minified'] + ASSETS_FILES['un-minified']
 
     for file in static_files:
         file_path = os.path.join(path, '_static', file)
@@ -27,7 +27,7 @@ def test_static_files_exists(app, status, warning):
 @pytest.mark.sphinx(
     srcdir=TEST_DOCS_SRC,
     confoverrides={
-        'RTD_SPHINX_SEARCH_FILE_TYPE': 'MINIFIED'
+        'rtd_sphinx_search_file_type': 'minified'
     }
 )
 def test_minified_static_files_injected_in_html(selenium, app, status, warning):
@@ -38,10 +38,10 @@ def test_minified_static_files_injected_in_html(selenium, app, status, warning):
     selenium.get(f'file://{path}')
     page_source = selenium.page_source
 
-    assert app.config.RTD_SPHINX_SEARCH_FILE_TYPE == 'MINIFIED'
+    assert app.config.rtd_sphinx_search_file_type == 'minified'
 
-    file_type = app.config.RTD_SPHINX_SEARCH_FILE_TYPE
-    files = CUSTOM_ASSETS_FILES[file_type]
+    file_type = app.config.rtd_sphinx_search_file_type
+    files = ASSETS_FILES[file_type]
 
     for file in files:
         file_name = file.split('/')[-1]
@@ -53,7 +53,7 @@ def test_minified_static_files_injected_in_html(selenium, app, status, warning):
 @pytest.mark.sphinx(
     srcdir=TEST_DOCS_SRC,
     confoverrides={
-        'RTD_SPHINX_SEARCH_FILE_TYPE': 'UN_MINIFIED'
+        'rtd_sphinx_search_file_type': 'un-minified'
     }
 )
 def test_un_minified_static_files_injected_in_html(selenium, app, status, warning):
@@ -64,10 +64,10 @@ def test_un_minified_static_files_injected_in_html(selenium, app, status, warnin
     selenium.get(f'file://{path}')
     page_source = selenium.page_source
 
-    assert app.config.RTD_SPHINX_SEARCH_FILE_TYPE == 'UN_MINIFIED'
+    assert app.config.rtd_sphinx_search_file_type == 'un-minified'
 
-    file_type = app.config.RTD_SPHINX_SEARCH_FILE_TYPE
-    files = CUSTOM_ASSETS_FILES[file_type]
+    file_type = app.config.rtd_sphinx_search_file_type
+    files = ASSETS_FILES[file_type]
 
     for file in files:
         file_name = file.split('/')[-1]