Skip to main content

Docutils Writer producing Tiny HTML

Project description

Docutils Tiny HTML Writer

Docutils Tiny HTML Writer is another docutils html writer, with very light html output. It was create mainly for use in other project’s like doc generators or web publishers, which wants to use their own html headers and footers.

One of possible use:

from docutils.core import publish_string, publish_parts
from docutils_tinyhtml import Writer
from sys import version_info

if version_info[0] < 3:
    from io import open

writer = Writer()
with open("README.rst", encoding="utf-8") as f:
    rst = f.read()

# store full html output to html variable
html = publish_string(source=rst,
                      writer=writer,
                      writer_name='html',
                      settings_overrides={'link': 'link', 'top': 'top'})

# disable system message in html, no in stderr
parts = publish_parts(source=rst,
                      writer=writer,
                      writer_name='html',
                      settings_overrides={'no_system_messages': True})

# store only html body
body = parts['html_title'] + parts['body'] + parts['html_line'] + \
    parts['html_footnotes'] + parts['html_citations'] + \
    parts['html_hyperlinks']

Or you can use rst2html-tiny command tool like standard rst2html:

~$ rst2html-tiny README.rst > README.html       # generate html from reStructured text
~$ rst2html-tiny -h                             # help output

If you have installed m2r package, you can use m2dhtml-tiny tool fro MarkDouwn source codes.

Installation

~$ pip install docutils-tinyhtmlwriter

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docutils-tinyhtmlwriter-1.3.0.tar.gz (20.7 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page