IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Restore support for list-style `source_suffix` with third-party parsers (#12584)

Browse Source
This commit is contained in:
Adam Turner 2024-07-15 12:45:26 +01:00 committed by GitHub
parent a874246c88
commit 55c8953ceb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.rst
View File

@ -4,6 +4,9 @@ Release 7.4.3 (in development)
Bugs fixed Bugs fixed
---------- ----------
* #12582: Restore support for list-styled :confval:`source_suffix` values
with extensions that register parsers.
Patch by Adam Turner.
Release 7.4.2 (released Jul 15, 2024) Release 7.4.2 (released Jul 15, 2024)
===================================== =====================================

10
sphinx/config.py
View File

@ -582,13 +582,17 @@ def convert_source_suffix(app: Sphinx, config: Config) -> None:
# The default filetype is determined on later step. # The default filetype is determined on later step.
# By default, it is considered as restructuredtext. # By default, it is considered as restructuredtext.
config.source_suffix = {source_suffix: 'restructuredtext'} config.source_suffix = {source_suffix: 'restructuredtext'}
logger.info(__("Converting `source_suffix = %r` to `source_suffix = %r`."),
source_suffix, config.source_suffix)
elif isinstance(source_suffix, (list, tuple)): elif isinstance(source_suffix, (list, tuple)):
# if list, considers as all of them are default filetype # if list, considers as all of them are default filetype
config.source_suffix = dict.fromkeys(source_suffix, 'restructuredtext') config.source_suffix = dict.fromkeys(source_suffix, 'restructuredtext')
logger.info(__("Converting `source_suffix = %r` to `source_suffix = %r`."),
source_suffix, config.source_suffix)
elif not isinstance(source_suffix, dict): elif not isinstance(source_suffix, dict):
logger.warning(__("The config value `source_suffix' expects " msg = __("The config value `source_suffix' expects a dictionary,"
"a string, list of strings, or dictionary. " "a string, or a list of strings. Got `%r' instead (type %s).")
"But `%r' is given." % source_suffix)) raise ConfigError(msg % (source_suffix, type(source_suffix)))
def convert_highlight_options(app: Sphinx, config: Config) -> None: def convert_highlight_options(app: Sphinx, config: Config) -> None:

8
sphinx/registry.py
View File

@ -504,10 +504,14 @@ def merge_source_suffix(app: Sphinx, config: Config) -> None:
for suffix, filetype in app.registry.source_suffix.items(): for suffix, filetype in app.registry.source_suffix.items():
if suffix not in app.config.source_suffix: # NoQA: SIM114 if suffix not in app.config.source_suffix: # NoQA: SIM114
app.config.source_suffix[suffix] = filetype app.config.source_suffix[suffix] = filetype
elif app.config.source_suffix[suffix] is None: elif app.config.source_suffix[suffix] == 'restructuredtext':
# filetype is not specified (default filetype). # The filetype is not specified (default filetype).
# So it overrides default filetype by extensions setting. # So it overrides default filetype by extensions setting.
app.config.source_suffix[suffix] = filetype app.config.source_suffix[suffix] = filetype
elif app.config.source_suffix[suffix] is None:
msg = __('`None` is not a valid filetype for %r.') % suffix
logger.warning(msg)
app.config.source_suffix[suffix] = filetype
# copy config.source_suffix to registry # copy config.source_suffix to registry
app.registry.source_suffix = app.config.source_suffix app.registry.source_suffix = app.config.source_suffix