def make_rest_doc(self, path=""):
fullpath = get_fullpath(self, path)
result = Rest(Title(fullpath, abovechar="=", belowchar="="),
ListItem(Strong("name:"), self._name),
ListItem(Strong("description:"), self.doc))
if self.cmdline is not None:
cmdline = get_cmdline(self.cmdline, fullpath)
result.add(ListItem(Strong("command-line:"), cmdline))
return result
def make_rest_doc(self, path=""):
content = super(ArbitraryOption, self).make_rest_doc(path)
content.add(ListItem(Strong("option type:"),
"arbitrary option (mostly internal)"))
if self.default is not None:
content.add(ListItem(Strong("default:"), str(self.default)))
elif self.defaultfactory is not None:
content.add(ListItem(Strong("factory for the default value:"),
str(self.defaultfactory)))
return content
def make_rest_doc(self, path=""):
fullpath = get_fullpath(self, path)
content = Rest(Title(fullpath, abovechar="=", belowchar="="))
toctree = []
for child in self._children:
subpath = fullpath + "." + child._name
toctree.append(subpath)
content.add(Directive("toctree", *toctree, **{'maxdepth': 4}))
content.join(ListItem(Strong("name:"), self._name),
ListItem(Strong("description:"), self.doc))
return content
def make_rest_doc(self, path=""):
fullpath = get_fullpath(self, path)
result = Rest(Title(fullpath, abovechar="=", belowchar="="),
Directive("contents"),
Paragraph(Link("back to parent", path + ".html")),
Title("Basic Option Information"),
ListItem(Strong("name:"), self._name),
ListItem(Strong("description:"), self.doc))
if self.cmdline is not None:
cmdline = get_cmdline(self.cmdline, fullpath)
result.add(ListItem(Strong("command-line:"), cmdline))
return result
def make_cmdline_overview(descr, title=True):
content = Rest()
if title:
content.add(
Title("Overview of Command Line Options for '%s'" %
(descr._name, ),
abovechar="=",
belowchar="="))
cmdlines = []
config = Config(descr)
for path in config.getpaths(include_groups=False):
subconf, step = config._cfgimpl_get_home_by_path(path)
fullpath = (descr._name + "." + path)
subdescr = getattr(subconf._cfgimpl_descr, step)
cmdline = get_cmdline(subdescr.cmdline, fullpath)
if cmdline is not None:
header = _get_section_header(cmdline, fullpath, subdescr)
cmdlines.append((header, cmdline, fullpath, subdescr))
cmdlines.sort(key=lambda x: (x[0], x[1].strip("-")))
currheader = ""
curr = content
for header, cmdline, fullpath, subdescr in cmdlines:
if header != currheader:
content.add(Title(header, abovechar="", belowchar="="))
curr = content.add(Paragraph())
currheader = header
curr.add(
ListItem(Link(cmdline + ":", fullpath + ".html"),
Text(subdescr.doc)))
return content
def make_rest_doc(self, path=""):
content = super(BoolOption, self).make_rest_doc(path)
fullpath = get_fullpath(self, path)
if self.negation and self.cmdline is not None:
if self.cmdline is DEFAULT_OPTION_NAME:
cmdline = '--%s' % (fullpath.replace('.', '-'), )
else:
cmdline = self.cmdline
neg_cmdline = [
"--" + _getnegation(argname.lstrip("-"))
for argname in cmdline.split() if argname.startswith("--")
][0]
content.add(
ListItem(Strong("command-line for negation:"), neg_cmdline))
content.add(ListItem(Strong("option type:"), "boolean option"))
if self.default is not None:
content.add(ListItem(Strong("default:"), str(self.default)))
if self._requires is not None:
requirements = [
ListItem(Link(opt, opt + ".html"),
"must be set to '%s'" % (rval, ))
for (opt, rval) in self._requires
]
if requirements:
content.add(ListItem(Strong("requirements:"), *requirements))
if self._suggests is not None:
suggestions = [
ListItem(Link(opt, opt + ".html"),
"should be set to '%s'" % (rval, ))
for (opt, rval) in self._suggests
]
if suggestions:
content.add(ListItem(Strong("suggestions:"), *suggestions))
return content
def make_rest_doc(self, path=""):
content = super(ChoiceOption, self).make_rest_doc(path)
content.add(ListItem(Strong("option type:"), "choice option"))
content.add(
ListItem(Strong("possible values:"),
*[ListItem(str(val)) for val in self.values]))
if self.default is not None:
content.add(ListItem(Strong("default:"), str(self.default)))
requirements = []
for val in self.values:
if val not in self._requires:
continue
req = self._requires[val]
requirements.append(
ListItem(
"value '%s' requires:" % (val, ), *[
ListItem(Link(opt, opt + ".html"),
"to be set to '%s'" % (rval, ))
for (opt, rval) in req
]))
if requirements:
content.add(ListItem(Strong("requirements:"), *requirements))
return content
def make_rest_doc(self, path=""):
content = super(StrOption, self).make_rest_doc(path)
content.add(ListItem(Strong("option type:"), "string option"))
if self.default is not None:
content.add(ListItem(Strong("default:"), str(self.default)))
return content