1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
import os
import sys
from docutils import nodes
from docutils.parsers.rst import Directive
from sphinx import addnodes
from sphinx.errors import SphinxError
from sphinx.util.nodes import split_explicit_title, process_index_entry, set_role_source_info
from htc_helpers import *
TOOLS = []
def find_tools(dir: str):
tools = []
man_pages = os.path.join(dir, "man-pages")
for man in os.listdir(man_pages):
if man[-4:] != ".rst" or man == "index.rst":
continue
man = man[:-4]
if man not in tools:
tools.append(man)
tools.sort()
return tools
def dump(obj):
for attr in dir(obj):
print("obj.%s = %r" % (attr, getattr(obj, attr)))
def tool_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
root_dir = get_rel_path_to_root_dir(inliner)[:-1]
original_name, program_index = custom_ext_parser(text)
program_name = original_name if original_name[:8] != "htcondor" else "htcondor"
if program_name not in TOOLS:
docname = inliner.document.settings.env.docname
warn(f"{docname} @ {lineno} | Referenced tool '{program_name}' has no corresponding man page. Typo perhaps?")
ref_link = f"href=\"{root_dir}/man-pages/{program_name}.html\""
return make_ref_and_index_nodes(name, original_name, program_index,
ref_link, rawtext, inliner, lineno, options)
def setup(app):
global TOOLS
TOOLS = find_tools(app.srcdir)
app.add_role("tool", tool_role)
|
