Mercurial > repos > shellac > guppy_basecaller
diff env/lib/python3.7/site-packages/docutils/examples.py @ 5:9b1c78e6ba9c draft default tip
"planemo upload commit 6c0a8142489327ece472c84e558c47da711a9142"
author | shellac |
---|---|
date | Mon, 01 Jun 2020 08:59:25 -0400 |
parents | 79f47841a781 |
children |
line wrap: on
line diff
--- a/env/lib/python3.7/site-packages/docutils/examples.py Thu May 14 16:47:39 2020 -0400 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,97 +0,0 @@ -# $Id: examples.py 7320 2012-01-19 22:33:02Z milde $ -# Author: David Goodger <goodger@python.org> -# Copyright: This module has been placed in the public domain. - -""" -This module contains practical examples of Docutils client code. - -Importing this module from client code is not recommended; its contents are -subject to change in future Docutils releases. Instead, it is recommended -that you copy and paste the parts you need into your own code, modifying as -necessary. -""" - -from docutils import core, io - - -def html_parts(input_string, source_path=None, destination_path=None, - input_encoding='unicode', doctitle=True, - initial_header_level=1): - """ - Given an input string, returns a dictionary of HTML document parts. - - Dictionary keys are the names of parts, and values are Unicode strings; - encoding is up to the client. - - Parameters: - - - `input_string`: A multi-line text string; required. - - `source_path`: Path to the source file or object. Optional, but useful - for diagnostic output (system messages). - - `destination_path`: Path to the file or object which will receive the - output; optional. Used for determining relative paths (stylesheets, - source links, etc.). - - `input_encoding`: The encoding of `input_string`. If it is an encoded - 8-bit string, provide the correct encoding. If it is a Unicode string, - use "unicode", the default. - - `doctitle`: Disable the promotion of a lone top-level section title to - document title (and subsequent section title to document subtitle - promotion); enabled by default. - - `initial_header_level`: The initial level for header elements (e.g. 1 - for "<h1>"). - """ - overrides = {'input_encoding': input_encoding, - 'doctitle_xform': doctitle, - 'initial_header_level': initial_header_level} - parts = core.publish_parts( - source=input_string, source_path=source_path, - destination_path=destination_path, - writer_name='html', settings_overrides=overrides) - return parts - -def html_body(input_string, source_path=None, destination_path=None, - input_encoding='unicode', output_encoding='unicode', - doctitle=True, initial_header_level=1): - """ - Given an input string, returns an HTML fragment as a string. - - The return value is the contents of the <body> element. - - Parameters (see `html_parts()` for the remainder): - - - `output_encoding`: The desired encoding of the output. If a Unicode - string is desired, use the default value of "unicode" . - """ - parts = html_parts( - input_string=input_string, source_path=source_path, - destination_path=destination_path, - input_encoding=input_encoding, doctitle=doctitle, - initial_header_level=initial_header_level) - fragment = parts['html_body'] - if output_encoding != 'unicode': - fragment = fragment.encode(output_encoding) - return fragment - -def internals(input_string, source_path=None, destination_path=None, - input_encoding='unicode', settings_overrides=None): - """ - Return the document tree and publisher, for exploring Docutils internals. - - Parameters: see `html_parts()`. - """ - if settings_overrides: - overrides = settings_overrides.copy() - else: - overrides = {} - overrides['input_encoding'] = input_encoding - output, pub = core.publish_programmatically( - source_class=io.StringInput, source=input_string, - source_path=source_path, - destination_class=io.NullOutput, destination=None, - destination_path=destination_path, - reader=None, reader_name='standalone', - parser=None, parser_name='restructuredtext', - writer=None, writer_name='null', - settings=None, settings_spec=None, settings_overrides=overrides, - config_section=None, enable_exit_status=None) - return pub.writer.document, pub