Jupyter Book v1 compatibility (#5)

* v0.6 prep
* Dark mode

Author: So-Cool

.github/workflows/pypi.yml

@@ -3,13 +3,13 @@ on: push
 jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v1
       with:
-        python-version: 3.7
+        python-version: 3.9
     - name: Install build dependencies
       run: pip install wheel
     - name: Build a binary wheel and a source tarball distributions 📦

MANIFEST.in

@@ -1,6 +1,7 @@
 include README.md
 include LICENCE
 include sphinx_prolog/_static/sphinx-prolog.css
+include sphinx_prolog/_static/jquery.js
 include sphinx_prolog/_static/jquery-ui.min.css
 include sphinx_prolog/_static/jquery-ui.min.js
 include sphinx_prolog/_static/lpn.css

setup.py

@@ -20,7 +20,7 @@
 URL = 'https://github.com/simply-logical/{}'.format(DISTNAME)
 DOWNLOAD_URL = 'https://pypi.org/project/{}/#files'.format(DISTNAME)
 PYTHON_REQUIRES = '~=3.5'  # Python 3.5 and up but not yet Python 4
-INSTALL_REQUIRES = ['docutils', 'pygments', 'sphinx>=3']
+INSTALL_REQUIRES = ['docutils', 'pygments', 'sphinx>=5']
 PACKAGES = find_packages(exclude=['*.tests', '*.tests.*', 'tests.*', 'tests'])
 INCLUDE_PACKAGE_DATA = True
 ZIP_SAFE = False  # We are using static files

sphinx_prolog/_static/jquery.js

@@ -1,8 +1,12 @@
+:root {
+  color-scheme: light dark;
+}
+
 div.source {
   position: relative;
   margin: 10px 2ex;
-  border: 1px solid #888;
-  background-color: #eee;
+  border: 1px solid light-dark(#888, #1d1d1d);
+  background-color: light-dark(#eee, #242424);
   padding: 4px 8px;
   border-radius: 5px;
 }
@@ -11,8 +15,8 @@ div.source {
 div.answer {
   position: relative;
   margin: 10px 2ex;
-  border: 1px solid #888;
-  background-color: #eee;
+  border: 1px solid light-dark(#888, #1d1d1d);
+  background-color: light-dark(#eee, #242424);
   padding: 4px 8px;
   border-radius: 5px;
 }

sphinx_prolog/_static/lpn.css

@@ -1,18 +1,28 @@
+/*
+Colours from:
+https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html
+https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/assets/styles/variables/_color.scss
+*/
+
+:root {
+  color-scheme: light dark;
+}
+
 /*Exercise directive*/
 .admonition.exercise {
-  border-color:#28a745;
+  border-color: light-dark(#f66a0a, #ff9245);
 }
 .admonition.exercise .admonition-title {
-  background-color: #f2fdf3;
+  background-color: light-dark(#f8e3d0, #652a02);
 }
-.admonition.exercise .admonition-title:before {
-  color:#28a745;
+.admonition.exercise .admonition-title:after {
+  color: light-dark(#f66a0a, #ff9245);
   content:"";
 }
 .admonition.exercise .admonition-title .solution-link {
-  color:#ffc107;
+  color: light-dark(#00843f, #5fb488);
   float: right;
-  font-family: Font Awesome\ 5 Free;
+  font-family: Font Awesome\ 6 Free;
   text-decoration: none;
   opacity:.3;
 }
@@ -23,19 +33,19 @@
 
 /*Exercise solution directive*/
 .admonition.solution {
-  border-color:#ffc107;
+  border-color: light-dark(#00843f, #5fb488);
 }
 .admonition.solution .admonition-title {
-  background-color: #fff6dd;
+  background-color: light-dark(#d6ece1, #002f17);
 }
-.admonition.solution .admonition-title:before {
-  color:#ffc107;
+.admonition.solution .admonition-title:after {
+  color: light-dark(#00843f, #5fb488);
   content:"";
 }
 .admonition.solution .admonition-title .exercise-link {
-  color:#28a745;
+  color: light-dark(#f66a0a, #ff9245);
   float: right;
-  font-family: Font Awesome\ 5 Free;
+  font-family: Font Awesome\ 6 Free;
   text-decoration: none;
   opacity:.3;
 }

sphinx_prolog/_static/sphinx-prolog.css

@@ -50,7 +50,7 @@ def depart_infobox_title_node(self, node):
 
     Overrides `Sphinx's HTML5 generator <https://github.com/sphinx-doc/sphinx/blob/68cc0f7e94f360a2c62ebcb761f8096e04ebf07f/sphinx/writers/html5.py#L362>`_.
     """
-    if (self.permalink_text and self.builder.add_permalinks
+    if (self.config.html_permalinks and self.builder.add_permalinks
             and node.parent.hasattr('ids') and node.parent['ids']):
         self.add_permalink_ref(node.parent, 'Permalink to this infobox')
     else:

sphinx_prolog/infobox.py

@@ -221,7 +221,7 @@ def depart_exercise_title_node(self, node):
 
     Overrides `Sphinx's HTML5 generator <https://github.com/sphinx-doc/sphinx/blob/68cc0f7e94f360a2c62ebcb761f8096e04ebf07f/sphinx/writers/html5.py#L362>`_.
     """
-    if (self.permalink_text and self.builder.add_permalinks
+    if (self.config.html_permalinks and self.builder.add_permalinks
             and node.parent.hasattr('ids') and node.parent['ids']):
         self.add_permalink_ref(node.parent, 'Permalink to this exercise')
     else:
@@ -496,7 +496,7 @@ def visit_solution_title_node(self, node):
 
 def depart_solution_title_node(self, node):
     """See the corresponding exercise function."""
-    if (self.permalink_text and self.builder.add_permalinks
+    if (self.config.html_permalinks and self.builder.add_permalinks
             and node.parent.hasattr('ids') and node.parent['ids']):
         self.add_permalink_ref(node.parent, 'Permalink to this solution')
     else:

sphinx_prolog/solex.py

@@ -16,8 +16,8 @@
 
 import sphinx_prolog
 
-STATIC_CSS_FILES = ['sphinx-prolog.css', 'lpn.css', 'jquery-ui.min.css']
-STATIC_JS_FILES = ['lpn.js', 'jquery-ui.min.js']
+STATIC_CSS_FILES = ['jquery-ui.min.css', 'lpn.css', 'sphinx-prolog.css']
+STATIC_JS_FILES = ['jquery.js', 'jquery-ui.min.js', 'lpn.js']
 STATIC_FILES = (STATIC_CSS_FILES + STATIC_JS_FILES
                 + ['lpn/lpn-run.png', 'lpn/lpn-close.png'])