minify HTML (#4)

* minify HTML

* fix typo

* keep comments

* adjust options

* adjust options

* adjust options

* fix banner typo

* adjust options

Author: njzjz

README.md

@@ -2,6 +2,11 @@
 
 This package should be used in all sphinx projects under the [@deepmodeling](https://github.com/deepmodeling) organization.
 
+## Features
+
+- Adding the DeepModeling banner
+- Minify HTML files
+
 ## How to use it
 
 Add `deepmodeling_sphinx` to the requirements, as well as the `extensions` of `conf.py`:

deepmodeling_sphinx/banner.html

@@ -44,6 +44,7 @@
                                     <p></p>
                                 </a>
                             </div>
+                        </div>
                     </li>
 
                     <li>

deepmodeling_sphinx/inject.py

@@ -2,6 +2,7 @@
 from typing import Dict, Any
 import os
 
+import minify_html
 from sphinx.application import Sphinx
 from sphinx.util.fileutil import copy_asset_file
 
@@ -33,7 +34,7 @@ def insert_sidebar(app, pagename, templatename, context, doctree):
     ):
         old_render = app.builder.templates.render
 
-        def rtd_render(self, template, render_context):
+        def render(self, template, render_context):
             content = old_render(template, render_context)
             comment_begin = r"<!--deepmodeling begin-->"
             comment_end = r"<!--deepmodeling end-->"
@@ -47,16 +48,34 @@ def rtd_render(self, template, render_context):
             with open(source) as f:
                 banner = f.read()
             if begin_body != -1:
-                content = content[:begin_body] + comment_begin + banner + comment_end + content[begin_body:]
+                content = content[:begin_body] + comment_begin + \
+                    banner + comment_end + content[begin_body:]
             return content
 
-        rtd_render._deepmodeling_patched = True
-        app.builder.templates.render = types.MethodType(rtd_render,
+        render._deepmodeling_patched = True
+        app.builder.templates.render = types.MethodType(render,
+                                                        app.builder.templates)
+
+
+def minify_html_files(app, pagename, templatename, context, doctree):
+    if (
+        not hasattr(app.builder.templates.render, '_deepmodeling_minified')
+    ):
+        old_render = app.builder.templates.render
+
+        def render(self, template, render_context):
+            content = old_render(template, render_context)
+            return minify_html.minify(content, minify_css=True, minify_js=True,
+                                      )
+
+        render._deepmodeling_minified = True
+        app.builder.templates.render = types.MethodType(render,
                                                         app.builder.templates)
 
 
 def setup(app: Sphinx) -> Dict[str, Any]:
     app.connect('builder-inited', copy_custom_files)
     app.connect('html-page-context', insert_sidebar)
+    app.connect('html-page-context', minify_html_files)
 
     return {'parallel_read_safe': True}

setup.py

@@ -5,7 +5,10 @@
     use_scm_version=True,
     setup_requires=['setuptools_scm'],
     packages=['deepmodeling_sphinx'],
-    install_require=['sphinx'],
+    install_requires=[
+        'sphinx',
+        'minify-html',
+    ],
     package_data={
         'deepmodeling_sphinx': ['banner.html',
                                 'banner.css',