From 220f88094b672a89bb165cf603a2890ba514ce1f Mon Sep 17 00:00:00 2001 From: James Knight Date: Sun, 14 Jul 2024 17:30:52 -0400 Subject: [PATCH] drop confluence_link_transform This capability is no longer supported due to it never being used (by both users and development). Removing it to help cleanup this extension. Signed-off-by: James Knight --- doc/configuration.rst | 9 --------- sphinxcontrib/confluencebuilder/__init__.py | 2 -- sphinxcontrib/confluencebuilder/builder.py | 5 +---- sphinxcontrib/confluencebuilder/config/checks.py | 6 ------ .../confluencebuilder/config/notifications.py | 2 -- tests/unit-tests/test_config_checks.py | 15 --------------- 6 files changed, 1 insertion(+), 38 deletions(-) diff --git a/doc/configuration.rst b/doc/configuration.rst index abf978bf..d7582fa6 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -2163,15 +2163,6 @@ Deprecated options This option has been replaced by |confluence_lang_overrides|_. -.. confval:: confluence_link_transform - - .. versionchanged:: 2.6 - - A function to override the translation of a document name to a (partial) - URI. The provided function is used to perform translations for both Sphinx's - get_relative_uri_ method. The default translation will be the combination of - "``docname`` + |confluence_link_suffix|_". - .. confval:: confluence_master_homepage .. versionchanged:: 1.6 diff --git a/sphinxcontrib/confluencebuilder/__init__.py b/sphinxcontrib/confluencebuilder/__init__.py index ff99f07f..14a11c7c 100644 --- a/sphinxcontrib/confluencebuilder/__init__.py +++ b/sphinxcontrib/confluencebuilder/__init__.py @@ -228,8 +228,6 @@ def setup(app): cm.add_conf('confluence_latex_macro', 'confluence') # Link suffix for generated files. cm.add_conf('confluence_link_suffix', 'confluence') - # Translation of docname to a (partial) URI. - cm.add_conf('confluence_link_transform', 'confluence') # Mappings for documentation mentions to Confluence keys. cm.add_conf('confluence_mentions', 'confluence') # Inject navigational hints into the documentation. diff --git a/sphinxcontrib/confluencebuilder/builder.py b/sphinxcontrib/confluencebuilder/builder.py index d4478468..a93b500b 100644 --- a/sphinxcontrib/confluencebuilder/builder.py +++ b/sphinxcontrib/confluencebuilder/builder.py @@ -180,10 +180,7 @@ def link_transform(docname): return docname + self.link_suffix self.file_transform = file_transform - if self.config.confluence_link_transform is not None: - self.link_transform = self.config.confluence_link_transform - else: - self.link_transform = link_transform + self.link_transform = link_transform if self.config.confluence_lang_overrides is not None: if isinstance(self.config.confluence_lang_overrides, dict): diff --git a/sphinxcontrib/confluencebuilder/config/checks.py b/sphinxcontrib/confluencebuilder/config/checks.py index bb39c878..e2075159 100644 --- a/sphinxcontrib/confluencebuilder/config/checks.py +++ b/sphinxcontrib/confluencebuilder/config/checks.py @@ -397,12 +397,6 @@ def validate_configuration(builder): # ################################################################## - # confluence_link_transform - validator.conf('confluence_link_transform') \ - .callable_() - - # ################################################################## - # confluence_mentions validator.conf('confluence_mentions') \ .dict_str_str() diff --git a/sphinxcontrib/confluencebuilder/config/notifications.py b/sphinxcontrib/confluencebuilder/config/notifications.py index 268d4eae..cddc80d6 100644 --- a/sphinxcontrib/confluencebuilder/config/notifications.py +++ b/sphinxcontrib/confluencebuilder/config/notifications.py @@ -18,8 +18,6 @@ 'to be removed in a future version', 'confluence_adv_writer_no_section_cap': 'to be removed in a future version', - 'confluence_link_transform': - 'capability to be dropped (please report if required)', 'confluence_master_homepage': 'use "confluence_root_homepage" instead', 'confluence_max_doc_depth': diff --git a/tests/unit-tests/test_config_checks.py b/tests/unit-tests/test_config_checks.py index 68bb68d9..939b76b2 100644 --- a/tests/unit-tests/test_config_checks.py +++ b/tests/unit-tests/test_config_checks.py @@ -550,21 +550,6 @@ def test_config_check_link_suffix(self): self.config['confluence_link_suffix'] = '.conf' self._try_config() - def test_config_check_link_transform(self): - self.config['suppress_warnings'] = [ - 'confluence.deprecated', - ] - - def mock_transform(docname): - return docname + '.conf' - - self.config['confluence_link_transform'] = mock_transform - self._try_config() - - self.config['confluence_link_transform'] = 'invalid' - with self.assertRaises(ConfluenceConfigError): - self._try_config() - def test_config_check_mentions(self): self.config['confluence_mentions'] = {} self._try_config()