Add a sphinx extension to automatically bold RFC 2119 words

Author: asmeurer

Diff for: src/_array_api_conf.py

@@ -37,6 +37,7 @@
     "sphinx_favicon",
     "sphinx_markdown_tables",
     "sphinxcontrib.jquery",
+    "autobold_rfc2119",
 ]
 
 autosummary_generate = True

Diff for: src/autobold_rfc2119.py

@@ -0,0 +1,30 @@
+from sphinx.application import Sphinx
+import re
+
+rfc_2119_words = [
+    'must',
+    'must not',
+    'required',
+    'shall',
+    'shall not',
+    'should',
+    'should not',
+    'recommended',
+    'not recommended',
+    'may',
+    'optional',
+]
+
+def bold_terms(source):
+    return re.sub(rf'\b({"|".join(rfc_2119_words)})\b(?!\[)', r'**\1**', source, flags=re.IGNORECASE)
+
+def bold_terms_source_read(app, docname, source):
+    source[0] = bold_terms(source[0])
+
+def bold_terms_autodoc(app, what, name, obj, options, lines):
+    for i in range(len(lines)):
+        lines[i] = bold_terms(lines[i])
+
+def setup(app: Sphinx):
+    app.connect('source-read', bold_terms_source_read)
+    app.connect('autodoc-process-docstring', bold_terms_autodoc)