本文整理汇总了Python中docutils.utils.new_document方法的典型用法代码示例。如果您正苦于以下问题:Python utils.new_document方法的具体用法?Python utils.new_document怎么用?Python utils.new_document使用的例子?那么, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类docutils.utils
的用法示例。
在下文中一共展示了utils.new_document方法的12个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: preload
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def preload(self, filename, encoding='utf-8', errors='strict'):
'''Preload a rst file to get its toctree and its title.
The result will be stored in :attr:`toctrees` with the ``filename`` as
key.
'''
with open(filename, 'rb') as fd:
text = fd.read().decode(encoding, errors)
# parse the source
document = utils.new_document('Document', self._settings)
self._parser.parse(text, document)
# fill the current document node
visitor = _ToctreeVisitor(document)
document.walkabout(visitor)
self.toctrees[filename] = visitor.toctree
return text
示例2: _load_from_text
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def _load_from_text(self, *largs):
try:
# clear the current widgets
self.content.clear_widgets()
self.anchors_widgets = []
self.refs_assoc = {}
# parse the source
document = utils.new_document('Document', self._settings)
text = self.text
if PY2 and type(text) is str:
text = text.decode('utf-8')
self._parser.parse(text, document)
# fill the current document node
visitor = _Visitor(self, document)
document.walkabout(visitor)
self.title = visitor.title or 'No title'
except:
Logger.exception('Rst: error while loading text')
示例3: renderList
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def renderList(l, markDownHelp, settings=None):
"""
Given a list of reStructuredText or MarkDown sections, return a docutils node list
"""
if len(l) == 0:
return []
if markDownHelp:
return parseMarkDownBlock('\n\n'.join(l) + '\n')
else:
if settings is None:
settings = OptionParser(components=(Parser,)).get_default_values()
document = new_document(None, settings)
Parser().parse('\n\n'.join(l) + '\n', document)
return document.children
示例4: parse
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def parse(self):
"""Parse `self.input` into a document tree."""
self.document = document = self.new_document()
self.parser.parse(self.input, document)
document.current_source = document.current_line = None
示例5: new_document
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def new_document(self):
"""Create and return a new empty document tree (root node)."""
document = utils.new_document(self.source.source_path, self.settings)
return document
示例6: build_row
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def build_row(item):
"""Return nodes.row with property description"""
prop, propschema, required = item
row = nodes.row()
# Property
row += nodes.entry("", nodes.paragraph(text=prop), classes=["vl-prop"])
# Type
str_type = type_description(propschema)
par_type = nodes.paragraph()
is_text = True
for part in reClassDef.split(str_type):
if part:
if is_text:
add_text(par_type, part)
else:
add_class_def(par_type, part)
is_text = not is_text
# row += nodes.entry('')
row += nodes.entry("", par_type) # , classes=["vl-type-def"]
# Description
md_parser = CommonMarkParser()
# str_descr = "***Required.*** " if required else ""
str_descr = ""
str_descr += propschema.get("description", " ")
doc_descr = utils.new_document("schema_description")
md_parser.parse(str_descr, doc_descr)
# row += nodes.entry('', *doc_descr.children, classes="vl-decsr")
row += nodes.entry("", *doc_descr.children, classes=["vl-decsr"])
return row
示例7: render
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def render(app, doctree, fromdocname):
for node in doctree.traverse(YaqlDocNode):
new_doc = utils.new_document('YAQL', doctree.settings)
content = generate_doc(node.source)
rst.Parser().parse(content, new_doc)
node.replace_self(new_doc.children)
示例8: get_releases
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def get_releases(self):
full_path = os.path.join(ROOT_DIR, "CHANGELOG.rst")
with open(full_path) as f:
changelog = f.read()
with mock.patch.object(sys, "stderr"):
parser = rst.Parser()
settings = frontend.OptionParser(
components=(rst.Parser,)).get_default_values()
document = utils.new_document(changelog, settings)
parser.parse(changelog, document)
changelog = document.children
if len(changelog) != 1:
self.fail("'%s' file should contain one global section "
"with subsections for each release." % full_path)
releases = []
for node in changelog[0].children:
if not isinstance(node, nodes.section):
continue
title = node.astext().split("\n", 1)[0]
result = self.RE_RELEASE.match(title)
if result:
releases.append(result.groupdict()["version"])
if not releases:
self.fail("'%s' doesn't mention any releases..." % full_path)
return releases
示例9: _parse_rst
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def _parse_rst(text):
parser = rst.Parser()
settings = frontend.OptionParser(
components=(rst.Parser,)).get_default_values()
document = utils.new_document(text, settings)
parser.parse(text, document)
return document.children
示例10: document
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def document(self):
if self._doc is None:
# Use the rst parsers document output to do as much of the
# validation as we can without resorting to custom logic (this
# parser is what sphinx and others use anyway so it's hopefully
# mature).
parser_cls = docutils_parser.get_parser_class("rst")
parser = parser_cls()
defaults = {
"halt_level": 5,
"report_level": 5,
"quiet": True,
"file_insertion_enabled": False,
"traceback": True,
# Development use only.
"dump_settings": False,
"dump_internals": False,
"dump_transforms": False,
}
opt = frontend.OptionParser(components=[parser], defaults=defaults)
doc = utils.new_document(
source_path=self.filename, settings=opt.get_default_values()
)
parser.parse(self.contents, doc)
self._doc = doc
return self._doc
示例11: assertParses
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def assertParses(self, source, expected, alt=False): # noqa
parser = CommonMarkParser()
parser.parse(dedent(source), new_document('<string>'))
self.maxDiff = None
self.assertMultiLineEqual(
dedent(expected).lstrip(),
dedent(parser.document.asdom().toprettyxml(indent=' ')),
)
示例12: parse_text
# 需要导入模块: from docutils import utils [as 别名]
# 或者: from docutils.utils import new_document [as 别名]
def parse_text(text):
parser = rst.Parser()
settings = frontend.OptionParser(components=(rst.Parser,)).get_default_values()
document = utils.new_document(text, settings)
parser.parse(text, document)
return document.children