From 6882a7717e8e15c63fe70a1b7c7d96d02b4fee0d Mon Sep 17 00:00:00 2001 From: Ilya Boyazitov Date: Sat, 30 Nov 2024 18:27:16 +0300 Subject: [PATCH 1/2] =?UTF-8?q?=E2=9C=A8=20NEW:=20Support=20parallel=20rea?= =?UTF-8?q?ding=20and=20writing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/sphinx_subfigure/main.py | 13 ++++++++++++- tox.ini | 4 ++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/sphinx_subfigure/main.py b/src/sphinx_subfigure/main.py index 377449c..b658b7f 100644 --- a/src/sphinx_subfigure/main.py +++ b/src/sphinx_subfigure/main.py @@ -2,22 +2,33 @@ import math import string +from typing import TYPE_CHECKING from docutils import nodes from docutils.parsers.rst import directives from sphinx.application import Sphinx from sphinx.util.docutils import SphinxDirective +from . import __version__ from .tr_html import setup_html from .tr_latex import setup_latex +if TYPE_CHECKING: + from typing import Any -def setup(app: Sphinx) -> None: + +def setup(app: Sphinx) -> dict[str, Any]: """Setup the extension.""" app.add_directive("subfigure", SubfigureDirective) setup_html(app) setup_latex(app) + return { + 'version': __version__, + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } + class SubfigureDirective(SphinxDirective): """A sphinx directive to create sub-figures.""" diff --git a/tox.ini b/tox.ini index b932ec1..bb80469 100644 --- a/tox.ini +++ b/tox.ini @@ -16,11 +16,11 @@ description = Build the documentation extras = docs setenv = BUILDER = {env:BUILDER:html} -whitelist_externals = +allowlist_externals = echo rm commands_pre = rm -rf docs/_build/{env:BUILDER} -commands = sphinx-build -nW --keep-going -b {env:BUILDER} {posargs} docs/ docs/_build/{env:BUILDER} +commands = sphinx-build -nW --keep-going -b {env:BUILDER} -j auto {posargs} docs/ docs/_build/{env:BUILDER} commands_post = echo "open file://{toxinidir}/docs/_build/html/index.html" [flake8] From 3d356bd1ec65cc6cc48f6940787fdafbcf69de19 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 30 Nov 2024 15:28:30 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/sphinx_subfigure/main.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/sphinx_subfigure/main.py b/src/sphinx_subfigure/main.py index b658b7f..c47d3c5 100644 --- a/src/sphinx_subfigure/main.py +++ b/src/sphinx_subfigure/main.py @@ -24,9 +24,9 @@ def setup(app: Sphinx) -> dict[str, Any]: setup_latex(app) return { - 'version': __version__, - 'parallel_read_safe': True, - 'parallel_write_safe': True, + "version": __version__, + "parallel_read_safe": True, + "parallel_write_safe": True, }