Update manual

.github/workflows/python-publish.yml

@@ -76,6 +76,10 @@ jobs:
       with:
         name: python-package-distributions
         path: dist/
+    - name: Upgrade Dependencies
+      run: |
+          python -m pip install --upgrade pip
+          pip install --upgrade sigstore cryptography
     - name: Sign the dists with Sigstore
       uses: sigstore/[email protected]
       with:

README.md

@@ -8,6 +8,7 @@ The default theme in JupyterBooks is usually not desired and need to be changed
 
 This extension applies styling changes, e.g. using specific fonts, and adding particular colours for admonitions. You can see how the TU Delft theme looks like applied in this [example book](http://teachbooks.io/TU-Delft-Theme-Example/).
 
+This extension also automatically sets the Delft University of Technology logo (unless specified otherwise).
 
 ## Installation
 To install the Sphinx-Image-Inverter, follow these steps:
@@ -39,6 +40,14 @@ sphinx:
 
 By following the steps above, the theme will be applied automatically. To see the examples of usage visit the [TeachBooks manual](https://teachbooks.io/manual/intro.html).
 
+If the Delft University of Technology logo should not be set (i.e. use logos defined by the user), include the following in your `_config.yml` file:
+```
+sphinx:
+  config:
+    ...
+    tud_change_logo: False
+```
+
 
 ## Contribute
-This tool's repository is stored on [GitHub](https://github.com/TeachBooks/Sphinx-TUDelft-theme). The `README.md` of the branch `Manual` is also part of the [TeachBooks manual](https://teachbooks.io/manual/intro.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/Sphinx-TUDelft-theme). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone [email protected]:TeachBooks/manual.git`.
+This tool's repository is stored on [GitHub](https://github.com/TeachBooks/Sphinx-TUDelft-theme). The `README.md` of the branch `Manual` is also part of the [TeachBooks manual](https://teachbooks.io/manual/intro.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/Sphinx-TUDelft-theme). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone [email protected]:TeachBooks/manual.git`.

src/sphinx_tudelft_theme/__init__.py

@@ -20,10 +20,33 @@ def copy_stylesheet(app: Sphinx, exc: None) -> None:
         copy_asset_file(style, static_dir)
         copy_asset_file(fonts_src_dir, fonts_dest_dir)
 
+def copy_logos(app: Sphinx, exc: None) -> None:
+    base_dir = os.path.dirname(__file__)
+    light = os.path.join(base_dir, 'static', 'TUDelft_logo_descriptor_rgb.png')
+    dark = os.path.join(base_dir, 'static', 'TUDelft_logo_descriptor_white.png')
+
+    if app.builder.format == 'html' and not exc:
+        static_dir = os.path.join(app.builder.outdir, '_static')
+
+        copy_asset_file(light, static_dir)
+        copy_asset_file(dark, static_dir)
+
+def set_logo(app,conf) -> None:
+    if conf.tud_change_logo:
+        print('Changing logo to TU Delft logo')
+        old =  app.config.html_theme_options
+        old['logo'] = {'image_light':'TUDelft_logo_descriptor_rgb.png','image_dark': 'TUDelft_logo_descriptor_white.png'}
+        app.config.html_theme_options = old
+    else:
+        print('Using user-defined logo')
+
 
 def setup(app: Sphinx):
+    app.add_config_value('tud_change_logo', True, 'env')
     app.add_css_file('tudelft_style.css')
     app.connect('build-finished', copy_stylesheet)
+    app.connect('build-finished', copy_logos)
+    app.connect('config-inited',set_logo)
     return {
         "version": __version__,
         "parallel_read_safe": True,