Merge branch 'master' into link-to-full-page

Author: dojutsu-user

MANIFEST.in

@@ -1,4 +1,6 @@
 prune common
 include LICENSE
+include sphinx_search/_static/js/rtd_sphinx_search.js
 include sphinx_search/_static/js/rtd_sphinx_search.min.js
+include sphinx_search/_static/css/rtd_sphinx_search.css
 include sphinx_search/_static/css/rtd_sphinx_search.min.css

docs/conf.py

@@ -176,3 +176,9 @@
 
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
+
+# -- Setup for 'confval' used in docs/configuration.rst ----------------------
+
+def setup(app):
+  app.add_object_type('confval', 'confval',
+    'pair: %s; configuration value')

docs/configuration.rst

@@ -0,0 +1,18 @@
+Configuration
+=============
+
+The following settings are available.
+You can customize these configuration options in your ``conf.py`` file:
+
+.. confval:: rtd_sphinx_search_file_type
+
+   Description: Type of files to be included in the html.
+
+   Possible values:
+
+   - ``minified``: Include the minified and uglified CSS and JS files.
+   - ``un-minified``: Include the original CSS and JS files.
+
+   Default: ``'minified'``
+
+   Type: ``string``

docs/index.rst

@@ -39,6 +39,7 @@ The CSS is also autoprefixed to extend the support to most of the browsers.
    :caption: Table of Contents
 
    installation
+   configuration
    custom-design
    development
    testing

sphinx_search/_static/js/rtd_sphinx_search.js

@@ -643,13 +643,9 @@ window.addEventListener("DOMContentLoaded", evt => {
         let initialHtml = generateAndReturnInitialHtml();
         document.body.innerHTML += initialHtml;
 
-        let search_outer_wrapper = document.querySelector(
-            ".search__outer__wrapper"
-        );
-        let search_outer_input = document.querySelector(
-            ".search__outer__input"
-        );
-        let cross_icon = document.querySelector(".search__cross");
+        let search_outer_wrapper = document.querySelector('.search__outer__wrapper');
+        let search_outer_input = document.querySelector('.search__outer__input');
+        let cross_icon = document.querySelector('.search__cross');
 
         // this denotes the search suggestion which is currently selected
         // via tha ArrowUp/ArrowDown keys.

sphinx_search/_static/js/rtd_sphinx_search.min.js

@@ -1,26 +1,49 @@
 import os
+
 from sphinx.util.fileutil import copy_asset
 
 
-CUSTOM_ASSETS_FILES = [
-    os.path.join('js', 'rtd_sphinx_search.min.js'),
-    os.path.join('css', 'rtd_sphinx_search.min.css'),
-]
+ASSETS_FILES = {
+    'minified': [
+        os.path.join('js', 'rtd_sphinx_search.min.js'),
+        os.path.join('css', 'rtd_sphinx_search.min.css'),
+    ],
+    'un-minified': [
+        os.path.join('js', 'rtd_sphinx_search.js'),
+        os.path.join('css', 'rtd_sphinx_search.css'),
+    ]
+}
 
 
 def copy_asset_files(app, exception):
     if exception is None:  # build succeeded
-        for f in CUSTOM_ASSETS_FILES:
-            path = os.path.join(os.path.dirname(__file__), '_static', f)
-            copy_asset(path, os.path.join(app.outdir, '_static', f.split('.')[-1]))
+        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 setup(app):
+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
+    expected_file_type = ASSETS_FILES.keys()
 
-    app.connect('build-finished', copy_asset_files)
+    assert (
+        file_type in expected_file_type
+    ), f'"{file_type}" file type is not supported.'
 
-    for file in CUSTOM_ASSETS_FILES:
-        if file.endswith('.min.js'):
+    files = ASSETS_FILES[file_type]
+
+    for file in files:
+        if file.endswith('.js'):
             app.add_js_file(file)
-        if file.endswith('.min.css'):
+        elif file.endswith('.css'):
             app.add_css_file(file)
+
+
+def setup(app):
+
+    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)

sphinx_search/extension.py

@@ -6,6 +6,7 @@
 import pytest
 
 from tests import TEST_DOCS_SRC
+from sphinx_search.extension import ASSETS_FILES
 
 
 @pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
@@ -14,31 +15,62 @@ def test_static_files_exists(app, status, warning):
     app.build()
     path = app.outdir
 
-    js_file = os.path.join(path, '_static', 'js', 'rtd_sphinx_search.min.js')
-    css_file = os.path.join(path, '_static', 'css', 'rtd_sphinx_search.min.css')
+    static_files = ASSETS_FILES['minified'] + ASSETS_FILES['un-minified']
 
-    assert (
-        os.path.exists(js_file) is True
-    ), 'js file should be copied to build folder'
+    for file in static_files:
+        file_path = os.path.join(path, '_static', file)
+        assert (
+            os.path.exists(file_path)
+        ), f'{file_path} should be present in the _build folder'
 
-    assert (
-        os.path.exists(css_file) is True
-    ), 'css file should be copied to build folder'
 
+@pytest.mark.sphinx(
+    srcdir=TEST_DOCS_SRC,
+    confoverrides={
+        'rtd_sphinx_search_file_type': 'minified'
+    }
+)
+def test_minified_static_files_injected_in_html(selenium, app, status, warning):
+    """Test if the static files are correctly injected in the html."""
+    app.build()
+    path = app.outdir / 'index.html'
 
-@pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
-def test_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'
+
+    file_type = app.config.rtd_sphinx_search_file_type
+    files = ASSETS_FILES[file_type]
+
+    for file in files:
+        file_name = file.split('/')[-1]
+        assert (
+            page_source.count(file_name) == 1
+        ), f'{file} should be present in the page source'
+
+
+@pytest.mark.sphinx(
+    srcdir=TEST_DOCS_SRC,
+    confoverrides={
+        'rtd_sphinx_search_file_type': 'un-minified'
+    }
+)
+def test_un_minified_static_files_injected_in_html(selenium, app, status, warning):
     """Test if the static files are correctly injected in the html."""
     app.build()
     path = app.outdir / 'index.html'
 
     selenium.get(f'file://{path}')
     page_source = selenium.page_source
 
-    assert (
-        page_source.count('rtd_sphinx_search.min.js') == 1
-    ), 'js file should be injected only once'
+    assert app.config.rtd_sphinx_search_file_type == 'un-minified'
+
+    file_type = app.config.rtd_sphinx_search_file_type
+    files = ASSETS_FILES[file_type]
 
-    assert (
-        page_source.count('rtd_sphinx_search.min.css') == 1
-    ), 'css file should be injected only once'
+    for file in files:
+        file_name = file.split('/')[-1]
+        assert (
+            page_source.count(file_name) == 1
+        ), f'{file_name} should be present in the page source'