Merge branch 'main' into MAINT_switch_prettier_fork

bsipocz · web-flow · commit e341fd80a4b8 · 2026-03-10T11:04:38.000-07:00
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,7 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - dependabot[bot]
+      - pre-commit-ci
+      - pre-commit-ci[bot]
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -28,7 +28,7 @@ jobs:
           python -m build
 
       - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.12.2
+        uses: pypa/gh-action-pypi-publish@v1.12.4
         with:
           user: __token__
           password: ${{ secrets.PYPI_KEY }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -2,7 +2,7 @@ name: continuous-integration
 
 on:
   push:
-    branches: [master]
+    branches: [main]
     tags:
       - 'v*'
   pull_request:
@@ -30,9 +30,9 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
         # Test last 2 major releases of Sphinx; regression fixtures target the latest.
-        sphinx: ["~=7.0", "~=8.0"]
+        sphinx: ["~=7.0", "~=8.0", "~=9.0"]
         include:
         - os: windows-latest
           python-version: 3.13
@@ -65,7 +65,7 @@ jobs:
     # Disabled for now with false &&
     - name: Upload to Codecov
       if: false && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11' && matrix.sphinx == '~=8.0' && github.repository == 'executablebooks/sphinx-book-theme' && github.event_name == 'pull_request'
-      uses: codecov/codecov-action@v5.0.7
+      uses: codecov/codecov-action@v5.4.0
       with:
         name: ebp-sbt-pytests-py3.11
         flags: pytests
@@ -109,7 +109,7 @@ jobs:
         from pathlib import Path
         import re
         text = Path("./warnings.txt").read_text().strip()
-        expected_warning_patterns = [r"kitchen\-sink", r"urllib/parse\.py", r"Glyph 10024 .*? missing from current font"]
+        expected_warning_patterns = [r"kitchen\-sink", r"urllib/parse\.py", r"Glyph 10024 .*? missing from current font", r"list assignment index out of range \[autodoc\]"]
         print("\n=== Sphinx Warnings ===\n\n" + text)  # Print just for reference so we can look at the logs
         unexpected = [l for l in text.splitlines() if not any(re.search(p, l) for p in expected_warning_patterns)]
         assert len(unexpected) == 0, unexpected
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -4,7 +4,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.12"
 
 python:
   install:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changelog
 
+## v1.2.0 -- 2026-03-09
+
+* Jupyterlite button - patched, merged version of #655 by @matthew-brett in https://github.com/executablebooks/sphinx-book-theme/pull/914
+* [ENH] Show source text on GitLab projects by @tymcauley in https://github.com/executablebooks/sphinx-book-theme/pull/916
+* Fix typo in docs by @user27182 in https://github.com/executablebooks/sphinx-book-theme/pull/913
+* prepare for latest pydata and python releases by @choldgraf in https://github.com/executablebooks/sphinx-book-theme/pull/920
+* Ignore PendingDeprecationWarning about parser_name deprecation with Docutils 0.22 by @mitya57 in https://github.com/executablebooks/sphinx-book-theme/pull/919
+* CI: adding cronjob by @bsipocz in https://github.com/executablebooks/sphinx-book-theme/pull/926
+* DOC: Fix margin directive documentation by @melissawm in https://github.com/executablebooks/sphinx-book-theme/pull/930
+* MAINT: adding sphinx9 and python3.14 support and bumping minimum sphinx to 7 and python to 3.11 by @bsipocz in https://github.com/executablebooks/sphinx-book-theme/pull/927
+
+
+**Full Changelog**:
+https://github.com/executablebooks/sphinx-book-theme/compare/v1.1.4...v1.2
+
+
 ## v1.1.2 -- 2024-02-13
 
 ([full changelog](https://github.com/executablebooks/sphinx-book-theme/compare/v1.1.1...3da24da74f6042599fe6c9e2d612f5cbdef42280))
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ theme. See the pages to the left for information about what you can configure wi
 See [the Sphinx Book Theme documentation](https://sphinx-book-theme.readthedocs.io/en/latest/)
 for more information.
 
-[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/master/graph/badge.svg
+[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/main/graph/badge.svg
 [codecov-link]: https://codecov.io/gh/executablebooks/sphinx-book-theme
 
 [rtd-badge]: https://readthedocs.org/projects/sphinx-book-theme/badge/?version=latest
diff --git a/docs/conf.py b/docs/conf.py
@@ -109,7 +109,7 @@
 html_theme_options = {
     "path_to_docs": "docs",
     "repository_url": "https://github.com/executablebooks/sphinx-book-theme",
-    "repository_branch": "master",
+    "repository_branch": "main",
     "launch_buttons": {
         "binderhub_url": "https://mybinder.org",
         "colab_url": "https://colab.research.google.com/",
@@ -190,6 +190,8 @@
 linkcheck_ignore = [
     "http://someurl/release",  # This is a fake link
     "https://doi.org",  # These don't resolve properly and cause SSL issues
+    "https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html",  # anchors throw a 403 forbidden error
+    "https://docutils.sourceforge.io/docs/ref/rst/directives.html",  # anchors throw a 403 forbidden error
 ]
 linkcheck_exclude_documents = ["changelog"]
 
diff --git a/docs/content/content-blocks.md b/docs/content/content-blocks.md
@@ -141,10 +141,17 @@ If you'd like in-line margin content with numbered references, see [](margin:sid
 
 Here's how you can use the `{margin}` directive:
 
-````{example}
-:no-container:
-:reverse:
+```{margin} **Here is my margin content**
+It is pretty cool!
+```
+
+:::{important}
+The `{margin}` directive should not be nested under other elements such as topics or admonitions.
+:::
+
+**Source**
 
+````
 ```{margin} **Here is my margin content**
 It is pretty cool!
 ```
@@ -217,23 +224,36 @@ We can reference the figure with {ref}`myfig4`. Or a numbered reference like
 
 Margin content can include all kinds of things, such as code blocks:
 
+**Code blocks in the margin**
+
 ````{margin} Code blocks in margins
 ```python
 print("here is some python")
 ```
 ````
 
+**Source**
+
+`````
 ````{margin} Code blocks in margins
 ```python
 print("here is some python")
 ```
 ````
 `````
 
-`````{example} Admonitions and images in the margin
-:no-container:
-:reverse:
+**Admonitions and images in the margin**
 
+````{margin} **Notes in margins**
+```{note}
+Wow, a note with an image in a margin!
+![](../images/cool.jpg)
+```
+````
+
+**Source**
+
+`````
 ````{margin} **Notes in margins**
 ```{note}
 Wow, a note with an image in a margin!
@@ -249,9 +269,16 @@ page to flow around them, rather than moving to the right margin.
 
 To add content sidebars, use this syntax:
 
-`````{example}
-:no-container:
+````{sidebar} **My sidebar title**
+```{note}
+Here is my sidebar content, it is pretty cool!
+```
+![](../images/cool.jpg)
+````
 
+**Source**
+
+`````
 ````{sidebar} **My sidebar title**
 ```{note}
 Here is my sidebar content, it is pretty cool!
@@ -265,6 +292,10 @@ However, the sidebar text will still be in line with your content. There are
 certain kinds of elements, such as "note" blocks and code cells, that may
 clash with your sidebar. If this happens, try using a `{margin}` instead.
 
+:::{important}
+The `{sidebar}` directive should not be nested under other elements such as topics or admonitions.
+:::
+
 ## Full-width content
 
 Full-width content extends into the right margin, making it stand out against
diff --git a/docs/contributing/setup.md b/docs/contributing/setup.md
@@ -39,17 +39,17 @@ Follow these steps:
    $ pre-commit install
    ```
 
-   :::{margin}
-   You can also run pre-commit via `tox`:
-   ```console
-   $ tox -e py38-pre-commit -- --all
-   ```
-   or manually run all `pre-commit` jobs for this repository:
+:::{margin}
+You can also run pre-commit via `tox`:
+```console
+$ tox -e py38-pre-commit -- --all
+```
+or manually run all `pre-commit` jobs for this repository:
 
-   ```console
-   $ pre-commit run --all-files
-   ```
-   :::
+```console
+$ pre-commit run --all-files
+```
+:::
 
 The rest of these instructions use `tox` to automate the installation and commands necessary to do many common things.
 
diff --git a/docs/contributing/tests.md b/docs/contributing/tests.md
@@ -14,8 +14,8 @@ $ tox
 You can specify a specific environment like so:
 
 ```console
-# Run the tests with Python 3.10, Sphinx 6
-$ tox -e py310-sphinx6
+# Run the tests with Python 3.12, Sphinx 8
+$ tox -e py312-sphinx8
 ```
 
 ## List all test environments
@@ -46,7 +46,7 @@ By default, `tox` will only install the necessary environment **once**.
 If you'd like to force a re-build, use the `-r` parameter. For example:
 
 ```console
-$ tox -r -e py310-sphinx6
+$ tox -r -e py312-sphinx8
 ```
 
 ## Test audits with lighthouse
@@ -63,7 +63,7 @@ To preview the output of these tests:
 
 ## Test multiple Sphinx versions
 
-This theme is tested against Sphinx 6-9.
+This theme is tested against Sphinx 7-9.
 We try to set up our regression tests such that there are no differences between these Sphinx versions.
 
 ### Unit tests
diff --git a/pyproject.toml b/pyproject.toml
@@ -37,9 +37,9 @@ description = "A clean book theme for scientific explanations and documentation
 dynamic = ["version"]
 readme = "README.md"
 
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 dependencies = [
-  "sphinx>=6.1",
+  "sphinx>=7.0",
   "pydata-sphinx-theme==0.16.1"
 ]
 
@@ -63,7 +63,7 @@ code_style = [
     "pre-commit"
 ]
 doc = [
-    "ablog",
+    "ablog>=0.11.13",
     "ipywidgets",
     "folium",
     "numpy",
diff --git a/src/sphinx_book_theme/__init__.py b/src/sphinx_book_theme/__init__.py
@@ -24,7 +24,7 @@
 from ._compat import findall
 from ._transforms import HandleFootnoteTransform
 
-__version__ = "1.1.4"
+__version__ = "1.3.0.dev"
 """sphinx-book-theme version"""
 
 SPHINX_LOGGER = logging.getLogger(__name__)
diff --git a/tests/test_build.py b/tests/test_build.py
@@ -9,13 +9,8 @@
 import sphinx
 from sphinx.testing.util import SphinxTestApp
 
-sphinx_version = parse(version("sphinx"))
-if sphinx_version.major < 7:
-    from sphinx.testing.path import path as sphinx_path
-else:
-    from pathlib import Path as sphinx_path
-
 
+sphinx_version = parse(version("sphinx"))
 path_tests = Path(__file__).parent
 
 
@@ -56,7 +51,7 @@ def html_tree(self, *path):
 def sphinx_build_factory(make_app, tmp_path):
     def _func(src_folder, **kwargs):
         copytree(path_tests / "sites" / src_folder, tmp_path / src_folder)
-        app = make_app(srcdir=sphinx_path(tmp_path / src_folder), **kwargs)
+        app = make_app(srcdir=Path(tmp_path / src_folder), **kwargs)
         return SphinxBuild(app, tmp_path / src_folder)
 
     yield _func
@@ -469,7 +464,7 @@ def test_sidenote(sphinx_build_factory, file_regression):
     page2 = sphinx_build.html_tree("page2.html")
 
     sidenote_html = page2.select("section > #sidenotes")
-    regression_file = "test_sidenote_6" if sphinx_version.major < 7 else "test_sidenote"
+    regression_file = "test_sidenote"
     file_regression.check(
         sidenote_html[0].prettify(),
         extension=".html",
@@ -487,9 +482,8 @@ def test_marginnote(sphinx_build_factory, file_regression):
     page2 = sphinx_build.html_tree("page2.html")
 
     marginnote_html = page2.select("section > #marginnotes")
-    regression_file = (
-        "test_marginnote_6" if sphinx_version.major < 7 else "test_marginnote"
-    )
+    regression_file = "test_marginnote"
+
     file_regression.check(
         marginnote_html[0].prettify(),
         extension=".html",
diff --git a/tox.ini b/tox.ini
@@ -17,7 +17,7 @@ envlist = py313-sphinx8
 usedevelop=true
 passenv = TERM  # To make terminal coloring / other variables pass through
 
-[testenv:py{311,312,313}-pre-commit]
+[testenv:py{311,312,313,314}-pre-commit]
 extras = code_style
 commands = pre-commit run {posargs}
 
@@ -60,9 +60,10 @@ commands =
         --re-ignore ".*\.pyc" \
         --re-ignore ".*~"
 
-[testenv:py{311,312,313}-sphinx{7,8}]
+[testenv:py{311,312,313,314}-sphinx{7,8,9}]
 extras = test
 deps =
     sphinx7: sphinx>=7,<8
     sphinx8: sphinx>=8,<9
+    sphinx9: sphinx>=9,<10
 commands = pytest {posargs}
