chore: Sphinx version pin, refactor config to set appropriate default (#68) (#97)

* feat: split commit and lint checks

* fix: checkout

* fix: yaml linter

* fix: versioning and #68

Author: SecondSkoll

canonical_sphinx/config.py

@@ -220,14 +220,11 @@ def config_inited(app: Sphinx, config: SphinxConfig) -> None:  # noqa: PLR0915,
     if (
         config.latex_elements == {}
     ):  # pyright: ignore [reportUnnecessaryComparison] type: # ignore[comparison-overlap]
-
         config.latex_elements = ast.literal_eval(config.latex_config)
 
     html_context = config.html_context
 
     disable_feedback_button = config.disable_feedback_button
-    if html_context.get("github_issues") and not disable_feedback_button:
-        html_js_files.append("github_issue_links.js")
 
     values_and_defaults = [
         ("product_tag", "_static/tag.png"),
@@ -244,6 +241,9 @@ def config_inited(app: Sphinx, config: SphinxConfig) -> None:  # noqa: PLR0915,
     for value, default in values_and_defaults:
         html_context.setdefault(value, default)
 
+    if html_context.get("github_issues") and not disable_feedback_button:
+        html_js_files.append("github_issue_links.js")
+
     html_context["has_contributor_listing"] = has_contributor_listing
 
     config.html_js_files.extend(html_js_files)

pyproject.toml

@@ -2,7 +2,7 @@
 name = "canonical-sphinx"
 dynamic = ["version", "readme"]
 dependencies = [
-    "Sphinx",
+    "Sphinx>=7.1.2",
     "furo",
     "myst-parser",
     "linkify-it-py",