users guide: Introduce :pragma: directive

1 files changed, 14 insertions, 0 deletions

diff --git a/docs/users_guide/conf.py b/docs/users_guide/conf.py
index 0732c5ccd4..c64e0a3693 100644
--- a/docs/users_guide/conf.py
+++ b/docs/users_guide/conf.py
@@ -146,6 +146,11 @@ def parse_ghci_cmd(env, sig, signode):
     # Reference name
     return name
 
+def parse_pragma(env, sig, signode):
+    name = sig.split(' ')[0]
+    signode += addnodes.desc_name('{-# '+name, sig + ' #-}')
+    return name
+
 def parse_flag(env, sig, signode):
 
     # Break flag into name and args
@@ -222,6 +227,15 @@ def setup(app):
                             Field('since', label='Introduced in GHC version', names=['since']),
                         ])
 
+    app.add_object_type('pragma', 'pragma',
+                        objname='Haskell pragma',
+                        parse_node=parse_pragma,
+                        indextemplate='pair: %s; pragma',
+                        doc_field_types=[
+                            Field('since', label='Introduced in GHC version', names=['since']),
+                            Field('where', label='Allowed contexts', names=['where'])
+                        ])
+
 def increase_python_stack():
     # Workaround sphinx-build recursion limit overflow:
     # pickle.dump(doctree, f, pickle.HIGHEST_PROTOCOL)