BUG: templates_path in config was overriding value set in extension (#…

…566)

* updating templates path

* moving to builder-inited and appending as well

* is this necessary to keep?

* config is needed

* filesystem layout link was updated

* adding jb project in tests, comments in init func

* adding jb project in tests, comments in init func

* added _build to gitignore

* have to add jupyter-book

* removing test for jupyter-book

* removing jb from dependency

* removing en/latest

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+_build
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

ARCHITECTURE.md

@@ -2,7 +2,7 @@
 
 This is a short overview of the general architecture and structure of the repository, to help you orient yourself.
 
-This theme uses [sphinx-theme-builder](https://sphinx-theme-builder.readthedocs.io/en/latest/) as its build backend, and follows the [filesystem layout](https://sphinx-theme-builder.readthedocs.io/en/latest/reference/filesystem-layout/) recommended by it.
+This theme uses [sphinx-theme-builder](https://sphinx-theme-builder.readthedocs.io/en/latest/) as its build backend, and follows the [filesystem layout](https://sphinx-theme-builder.readthedocs.io/en/latest/filesystem-layout/) recommended by it.
 See below for some more specific sections
 
 ```{contents}

docs/reference/extensions.md

@@ -26,7 +26,7 @@ See the [paragraph markup page](kitchen-sink/paragraph-markup.rst) for more refe
 
 ## `ABlog` - Blog post list
 
-[ABlog](https://ablog.readthedocs.io/en/latest/) is a Sphinx extension for blogging with Sphinx.
+[ABlog](https://ablog.readthedocs.io/) is a Sphinx extension for blogging with Sphinx.
 
 Here's a sample post list:
 

src/sphinx_book_theme/__init__.py

@@ -164,6 +164,16 @@ def run(self):
         return nodes
 
 
+def update_general_config(app, config):
+    theme_dir = get_html_theme_path()
+    # Update templates for sidebar. Needed for jupyter-book builds as jb
+    # uses an instance of Sphinx class from sphinx.application to build the app.
+    # The __init__ function of which calls self.config.init_values() just
+    # before emitting `config-inited` event. The init_values function overwrites
+    # templates_path variable.
+    config.templates_path.append(os.path.join(theme_dir, "components"))
+
+
 def setup(app: Sphinx):
     # Register theme
     theme_dir = get_html_theme_path()
@@ -176,6 +186,7 @@ def setup(app: Sphinx):
 
     # Events
     app.connect("builder-inited", update_thebe_config)
+    app.connect("config-inited", update_general_config)
     app.connect("html-page-context", add_metadata_to_page)
     app.connect("html-page-context", hash_html_assets)
 
@@ -194,7 +205,8 @@ def setup(app: Sphinx):
     # Post-transforms
     app.add_post_transform(HandleFootnoteTransform)
 
-    # Update templates for sidebar
+    # Update templates for sidebar, for builds where config-inited is not called
+    # (does not work in case of jupyter-book)
     app.config.templates_path.append(os.path.join(theme_dir, "components"))
 
     return {