Merge branch 'master' into snowball/all

# Conflicts:
#	CHANGES.rst
#	sphinx/search/_stopwords/da.py
#	sphinx/search/_stopwords/da.txt
#	sphinx/search/_stopwords/de.py
#	sphinx/search/_stopwords/de.txt
#	sphinx/search/_stopwords/en.py
#	sphinx/search/_stopwords/es.py
#	sphinx/search/_stopwords/es.txt
#	sphinx/search/_stopwords/fi.py
#	sphinx/search/_stopwords/fi.txt
#	sphinx/search/_stopwords/fr.py
#	sphinx/search/_stopwords/fr.txt
#	sphinx/search/_stopwords/hu.py
#	sphinx/search/_stopwords/hu.txt
#	sphinx/search/_stopwords/it.py
#	sphinx/search/_stopwords/it.txt
#	sphinx/search/_stopwords/nl.py
#	sphinx/search/_stopwords/nl.txt
#	sphinx/search/_stopwords/no.py
#	sphinx/search/_stopwords/no.txt
#	sphinx/search/_stopwords/pt.py
#	sphinx/search/_stopwords/pt.txt
#	sphinx/search/_stopwords/ru.py
#	sphinx/search/_stopwords/ru.txt
#	sphinx/search/_stopwords/sv.py
#	sphinx/search/_stopwords/sv.txt
#	sphinx/search/en.py
#	sphinx/search/zh.py

Author: AA-Turner

CHANGES.rst

@@ -19,6 +19,7 @@ Features added
 * #13439: linkcheck: Permit warning on every redirect with
   ``linkcheck_allowed_redirects = {}``.
   Patch by Adam Turner.
+* #13497: Support C domain objects in the table of contents.
 * #13535: html search: Update to the latest version of Snowball (v3.01.)
   Patch by Adam Turner.
 

sphinx/domains/c/__init__.py

@@ -39,7 +39,7 @@
 
     from docutils.nodes import Element, Node, TextElement, system_message
 
-    from sphinx.addnodes import pending_xref
+    from sphinx.addnodes import desc_signature, pending_xref
     from sphinx.application import Sphinx
     from sphinx.builders import Builder
     from sphinx.domains.c._symbol import LookupKey
@@ -309,6 +309,32 @@ def after_content(self) -> None:
         self.env.current_document.c_parent_symbol = self.oldParentSymbol
         self.env.ref_context['c:parent_key'] = self.oldParentKey
 
+    def _object_hierarchy_parts(self, sig_node: desc_signature) -> tuple[str, ...]:
+        last_symbol: Symbol = self.env.current_document.c_last_symbol
+        return tuple(map(str, last_symbol.get_full_nested_name().names))
+
+    def _toc_entry_name(self, sig_node: desc_signature) -> str:
+        if not sig_node.get('_toc_parts'):
+            return ''
+
+        config = self.config
+        objtype = sig_node.parent.get('objtype')
+        if config.add_function_parentheses and (
+            objtype in {'function', 'method'}
+            or (objtype == 'macro' and '(' in sig_node.rawsource)
+        ):
+            parens = '()'
+        else:
+            parens = ''
+        *parents, name = sig_node['_toc_parts']
+        if config.toc_object_entries_show_parents == 'domain':
+            return '::'.join((name + parens,))
+        if config.toc_object_entries_show_parents == 'hide':
+            return name + parens
+        if config.toc_object_entries_show_parents == 'all':
+            return '::'.join([*parents, name + parens])
+        return ''
+
 
 class CMemberObject(CObject):
     object_type = 'member'

sphinx/search/__init__.py

@@ -91,11 +91,8 @@ class SearchLanguage:
     _word_re = re.compile(r'\w+')
 
     def __init__(self, options: dict[str, str]) -> None:
-        self.options = options
-        self.init(options)
-
-    def init(self, options: dict[str, str]) -> None:
         """Initialize the class with the options the user has given."""
+        self.options = options
 
     def split(self, input: str) -> list[str]:
         """This method splits a sentence into words.  Default splitter splits input

sphinx/search/da.py

@@ -14,7 +14,8 @@ class SearchDanish(SearchLanguage):
     js_stemmer_rawcode = 'danish-stemmer.js'
     stopwords = DANISH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('danish')
 
     def stem(self, word: str) -> str:

sphinx/search/de.py

@@ -14,7 +14,8 @@ class SearchGerman(SearchLanguage):
     js_stemmer_rawcode = 'german-stemmer.js'
     stopwords = GERMAN_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('german')
 
     def stem(self, word: str) -> str:

sphinx/search/en.py

@@ -14,7 +14,8 @@ class SearchEnglish(SearchLanguage):
     js_stemmer_rawcode = 'english-stemmer.js'
     stopwords = ENGLISH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('english')
 
     def stem(self, word: str) -> str:

sphinx/search/es.py

@@ -14,7 +14,8 @@ class SearchSpanish(SearchLanguage):
     js_stemmer_rawcode = 'spanish-stemmer.js'
     stopwords = SPANISH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('spanish')
 
     def stem(self, word: str) -> str:

sphinx/search/fi.py

@@ -14,7 +14,8 @@ class SearchFinnish(SearchLanguage):
     js_stemmer_rawcode = 'finnish-stemmer.js'
     stopwords = FINNISH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('finnish')
 
     def stem(self, word: str) -> str:

sphinx/search/fr.py

@@ -14,7 +14,8 @@ class SearchFrench(SearchLanguage):
     js_stemmer_rawcode = 'french-stemmer.js'
     stopwords = FRENCH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('french')
 
     def stem(self, word: str) -> str:

sphinx/search/hu.py

@@ -14,7 +14,8 @@ class SearchHungarian(SearchLanguage):
     js_stemmer_rawcode = 'hungarian-stemmer.js'
     stopwords = HUNGARIAN_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('hungarian')
 
     def stem(self, word: str) -> str:

sphinx/search/it.py

@@ -14,7 +14,8 @@ class SearchItalian(SearchLanguage):
     js_stemmer_rawcode = 'italian-stemmer.js'
     stopwords = ITALIAN_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('italian')
 
     def stem(self, word: str) -> str:

sphinx/search/ja.py

@@ -523,7 +523,8 @@ class SearchJapanese(SearchLanguage):
     lang = 'ja'
     language_name = 'Japanese'
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         dotted_path = options.get('type')
         if dotted_path is None:
             self.splitter = DefaultSplitter(options)

sphinx/search/nl.py

@@ -14,7 +14,8 @@ class SearchDutch(SearchLanguage):
     js_stemmer_rawcode = 'dutch-stemmer.js'
     stopwords = DUTCH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('dutch')
 
     def stem(self, word: str) -> str:

sphinx/search/no.py

@@ -14,7 +14,8 @@ class SearchNorwegian(SearchLanguage):
     js_stemmer_rawcode = 'norwegian-stemmer.js'
     stopwords = NORWEGIAN_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('norwegian')
 
     def stem(self, word: str) -> str:

sphinx/search/pt.py

@@ -14,7 +14,8 @@ class SearchPortuguese(SearchLanguage):
     js_stemmer_rawcode = 'portuguese-stemmer.js'
     stopwords = PORTUGUESE_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('portuguese')
 
     def stem(self, word: str) -> str:

sphinx/search/ro.py

@@ -13,7 +13,8 @@ class SearchRomanian(SearchLanguage):
     js_stemmer_rawcode = 'romanian-stemmer.js'
     stopwords = frozenset()
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('romanian')
 
     def stem(self, word: str) -> str:

sphinx/search/ru.py

@@ -14,7 +14,8 @@ class SearchRussian(SearchLanguage):
     js_stemmer_rawcode = 'russian-stemmer.js'
     stopwords = RUSSIAN_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('russian')
 
     def stem(self, word: str) -> str:

sphinx/search/sv.py

@@ -14,7 +14,8 @@ class SearchSwedish(SearchLanguage):
     js_stemmer_rawcode = 'swedish-stemmer.js'
     stopwords = SWEDISH_STOPWORDS
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('swedish')
 
     def stem(self, word: str) -> str:

sphinx/search/tr.py

@@ -13,7 +13,8 @@ class SearchTurkish(SearchLanguage):
     js_stemmer_rawcode = 'turkish-stemmer.js'
     stopwords = frozenset()
 
-    def init(self, options: dict[str, str]) -> None:
+    def __init__(self, options: dict[str, str]) -> None:
+        super().__init__(options)
         self.stemmer = snowballstemmer.stemmer('turkish')
 
     def stem(self, word: str) -> str:

sphinx/search/zh.py

@@ -46,8 +46,6 @@ class SearchChinese(SearchLanguage):
     def __init__(self, options: dict[str, str]) -> None:
         super().__init__(options)
         self.latin_terms: set[str] = set()
-
-    def init(self, options: dict[str, str]) -> None:
         dict_path = options.get('dict', JIEBA_DEFAULT_DICT)
         if dict_path and Path(dict_path).is_file():
             jieba_load_userdict(str(dict_path))