Blame docs/src/sphinx-plugins/manpage.py

Packit b5b901
# encoding: utf-8
Packit b5b901
Packit b5b901
#
Packit b5b901
# Copyright (c) 2013 Dariusz Dwornikowski.  All rights reserved.
Packit b5b901
#
Packit b5b901
# Adapted from https://github.com/tdi/sphinxcontrib-manpage
Packit b5b901
# License: Apache 2
Packit b5b901
#
Packit b5b901
Packit b5b901
Packit b5b901
import re
Packit b5b901
Packit b5b901
from docutils import nodes, utils
Packit b5b901
from docutils.parsers.rst.roles import set_classes
Packit b5b901
from string import Template
Packit b5b901
Packit b5b901
Packit b5b901
def make_link_node(rawtext, app, name, manpage_num, options):
Packit b5b901
    ref = app.config.man_url_regex
Packit b5b901
    if not ref:
Packit Service e08953
        ref = "http://man7.org/linux/man-pages/man%s/%s.%s.html" %(manpage_num, name, manpage_num)
Packit b5b901
    else:
Packit b5b901
        s = Template(ref)
Packit b5b901
        ref = s.substitute(num=manpage_num, topic=name)
Packit b5b901
    set_classes(options)
Packit b5b901
    node = nodes.reference(rawtext, "%s(%s)" % (name, manpage_num), refuri=ref, **options)
Packit b5b901
    return node
Packit b5b901
Packit b5b901
Packit b5b901
def man_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
Packit b5b901
    app = inliner.document.settings.env.app
Packit b5b901
    p = re.compile("([a-zA-Z0-9_\.-_]+)\((\d)\)")
Packit b5b901
    m = p.match(text)
Packit b5b901
Packit b5b901
    manpage_num = m.group(2)
Packit b5b901
    name = m.group(1)
Packit b5b901
    node = make_link_node(rawtext, app, name, manpage_num, options)
Packit b5b901
    return [node], []
Packit b5b901
Packit b5b901
Packit b5b901
def setup(app):
Packit b5b901
    app.add_role('man', man_role)
Packit b5b901
    app.add_config_value('man_url_regex', None, 'env')
Packit b5b901
    return
Packit b5b901