manpage Namespace Reference

Functions
def	make_link_node (rawtext, app, name, manpage_num, options)
def	man_role (name, rawtext, text, lineno, inliner, options={}, content=[])
def	setup (app)

Function Documentation

make_link_node()

def manpage.make_link_node	(		rawtext,
			app,
			name,
			manpage_num,
			options
	)

Definition at line 18 of file manpage.py.

def make_link_node(rawtext, app, name, manpage_num, options):
    ref = app.config.man_url_regex
    if not ref:
        ref = "https://man7.org/linux/man-pages/man%s/%s.%s.html" %(manpage_num, name, manpage_num)
    else:
        s = Template(ref)
        ref = s.substitute(num=manpage_num, topic=name)
    set_classes(options)
    node = nodes.reference(rawtext, "%s(%s)" % (name, manpage_num), refuri=ref, **options)
    return node
 
 

Referenced by man_role().

man_role()

def manpage.man_role	(		name,
			rawtext,
			text,
			lineno,
			inliner,
			options = {},
			content = []
	)

Definition at line 30 of file manpage.py.

def man_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
    app = inliner.document.settings.env.app
    p = re.compile("([a-zA-Z0-9_\.-_]+)\‍((\d)\‍)")
    m = p.match(text)
 
    manpage_num = m.group(2)
    name = m.group(1)
    node = make_link_node(rawtext, app, name, manpage_num, options)
    return [node], []
 
 

References make_link_node().

setup()

def manpage.setup

(

app

)

Definition at line 41 of file manpage.py.

def setup(app):
    app.add_role('man', man_role)
    app.add_config_value('man_url_regex', None, 'env')
    return