[FIX] Template Overriding - Add PR #566 Changes Back

[adam-grant-hendry]

• Change update_general_config() to run on config-inited event in setup() method
• Add config parameter back to update_general_config() method

Fixes:

• fixes #768
• fixes #729
• fixes #719

[welcome[bot]]

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

[adam-grant-hendry]

@choldgraf Do you have an option for me to request a reviewer? I couldn't find an option in the Contributing Guide.

[agoose77]

@adam-grant-hendry thanks for opening this PR — I'm picking up the thread to try and get the issue resolved. Could you confirm whether your last reply to @choldgraf above is a reasonable solution - to simply inform users that they should not place the theme in extensions? If so, then we can close this PR? :)

[ghisvail]

I am also affected by the html-page-context event error. It was a bit hard to follow this thread, just wanted to know how close you think you are to a working fix, and possibly a follow-up release ?

[choldgraf]

@ghisvail the short answer is to just not add this theme to your extensions list. Adding it as the html_theme is enough and should avoid this bug.

https://github.com/executablebooks/sphinx-book-theme/pull/770#discussion_r1394965818

[adam-grant-hendry]

@agoose77 Yes, that should be fine. A new PR can be created to add the note to the documentation.

[ghisvail]

@ghisvail the short answer is to just not add this theme to your extensions list. Adding it as the html_theme is enough and should avoid this bug.

#770 (comment)

I am sorry to insist, but I don't understand what you mean. I am using JB, and the only reference to extensions is here:

  extra_extensions:
  - 'sphinx.ext.autodoc'
  - 'sphinx.ext.autosummary'
  - 'sphinx.ext.napoleon'
  - 'sphinx.ext.viewcode'
  - 'sphinx_toolbox.more_autosummary'
  - 'sphinx_toolbox.more_autodoc.typehints'
  - 'sphinxcontrib.mermaid'

I don't see any explicit reference to sphinx-book-theme.

[ghisvail]

Now I got it, it's jupyter-book config which adds sphinx-book-theme to extensions in the generated docs/conf.py.

If I remove it manually and then perform a build with sphinx-build, then it works.