glossary_search.py

"""Feature search results for glossary items prominently."""

from __future__ importannotations

importjson
frompathlibimportPath
fromtypingimportTYPE_CHECKING

fromdocutilsimportnodes
fromsphinx.addnodesimportglossary
fromsphinx.utilimportlogging

ifTYPE_CHECKING:
fromsphinx.applicationimportSphinx
fromsphinx.util.typingimportExtensionMetadata

logger=logging.getLogger(__name__)


defprocess_glossary_nodes(
app: Sphinx,
doctree: nodes.document,
_docname: str,
) ->None:
ifapp.builder.format!='html'orapp.builder.embedded:
return

ifhasattr(app.env, 'glossary_terms'):
terms=app.env.glossary_terms
else:
terms=app.env.glossary_terms= {}

fornodeindoctree.findall(glossary):
forglossary_iteminnode.findall(nodes.definition_list_item):
term=glossary_item[0].astext()
definition=glossary_item[-1]

rendered=app.builder.render_partial(definition)
terms[term.lower()] = {
'title': term,
'body': rendered['html_body'],
 }


defwrite_glossary_json(app: Sphinx, _exc: Exception) ->None:
ifnotgetattr(app.env, 'glossary_terms', None):
return

logger.info('Writing glossary.json', color='green')
dest=Path(app.outdir, '_static', 'glossary.json')
dest.parent.mkdir(exist_ok=True)
dest.write_text(json.dumps(app.env.glossary_terms), encoding='utf-8')


defsetup(app: Sphinx) ->ExtensionMetadata:
app.connect('doctree-resolved', process_glossary_nodes)
app.connect('build-finished', write_glossary_json)

return {
'version': '1.0',
'parallel_read_safe': True,
'parallel_write_safe': True,
 }