Commit 5c10f5ce authored by Ben Gamari's avatar Ben Gamari Committed by Ben Gamari

users_guide: Add ghci-cmd directive

Note only does this make the markup cleaner and more semantic, but it
clears up some warnings and enables proper hyperlinks. Yay Sphinx!

While I was at it I generally cleaned up the markup

Test Plan: Read it

Reviewers: hvr, thomie, austin

Differential Revision: https://phabricator.haskell.org/D1730
parent da0f0430
......@@ -110,3 +110,17 @@ texinfo_documents = [
u'GHC Team', 'GHCUsersGuide', 'The Glasgow Haskell Compiler.',
'Compilers'),
]
def parse_ghci_cmd(env, sig, signode):
from sphinx import addnodes
name = sig.split(';')[0]
sig = sig.replace(';', '')
signode += addnodes.desc_name(name, sig)
return name
def setup(app):
# the :ghci-cmd: directive used in ghci.rst
app.add_object_type('ghci-cmd', 'ghci-cmd',
parse_node=parse_ghci_cmd,
objname='GHCi command',
indextemplate='pair: %s; GHCi command')
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment