Merge branch 'master' of https://github.com/rk700/PyMuPDF

Author: JorjMcKie

README.md

@@ -15,7 +15,7 @@ On **[PyPI](https://pypi.org/project/PyMuPDF)** since August 2016: [![Downloads]
 
 # Introduction
 
-PyMuPDF (current version 1.18.9) is a Python binding with support for [MuPDF](https://mupdf.com/) (current version 1.18.*), a lightweight PDF, XPS, and E-book viewer, renderer and toolkit, which is maintained and developed by Artifex Software, Inc.
+PyMuPDF (current version 1.18.9) is a Python binding with support for [MuPDF](https://mupdf.com/) (current version 1.18.*), a lightweight PDF, XPS, and E-book viewer, renderer, and toolkit, which is maintained and developed by Artifex Software, Inc.
 
 MuPDF can access files in PDF, XPS, OpenXPS, CBZ, EPUB and FB2 (e-books) formats, and it is known for its top performance and high rendering quality.
 
@@ -58,7 +58,8 @@ Have a look at the basic [demos](https://github.com/pymupdf/PyMuPDF-Utilities/tr
 
 Our **documentation**, written using Sphinx, is available in various formats from the following sources. It currently is a combination of a reference guide and a user manual. For a **quick start** look at the [tutorial](https://pymupdf.readthedocs.io/en/latest/tutorial/) and the [recipes](https://pymupdf.readthedocs.io/en/latest/faq/) chapters.
 
-* You can view it online at [Read the Docs](https://readthedocs.org/projects/pymupdf/). This site also provides download options for zipped HTML and PDF.
+* You can view it online at [Read the Docs](https://readthedocs.org/projects/pymupdf/). This site also provides download options for PDF.
+* The search function on Read the Docs does not work for me currently. If you want a working searchable local version, please download a zipped HTML for [here](https://github.com/pymupdf/PyMuPDF-optional-material/tree/master/doc/pymupdf.zip).
 * Find a Windows help file [here](https://github.com/pymupdf/PyMuPDF-optional-material/tree/master/doc/PyMuPDF.chm).
 
 

demo/pymupdf.jpg

@@ -19,6 +19,7 @@
 # extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage", "sphinx.ext.ifconfig"]
 extensions = [
     "extensions.searchrepair",
+    "extensions.extension",
 ]
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/conf.py

@@ -0,0 +1,50 @@
+import os
+
+from sphinx.errors import ExtensionError
+from sphinx.util.fileutil import copy_asset
+
+
+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
+        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
+    expected_file_type = ASSETS_FILES.keys()
+
+    if file_type not in expected_file_type:
+        raise ExtensionError(f'"{file_type}" file type is not supported')
+
+    files = ASSETS_FILES[file_type]
+
+    for file in files:
+        if file.endswith('.js'):
+            app.add_js_file(file)
+        elif file.endswith('.css'):
+            app.add_css_file(file)
+
+
+def setup(app):
+
+    app.add_config_value('rtd_sphinx_search_file_type', 'minified', 'html')
+
+    app.connect('builder-inited', inject_static_files)
+    app.connect('build-finished', copy_asset_files)

docs/extensions/extension.py

@@ -17,6 +17,8 @@ def modify_search_index(app, exception):
             searchfile = open(filename, "w")
             searchfile.write(data2)
             searchfile.close()
+        else:
+            print("INFO: No file", filename)
 
 
 def setup(app):