Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Docutils Writer producing Tiny HTML

Project description

Docutils Tiny HTML Writer

This is a fork of https://github.com/ondratu/docutils-tinyhtmlwriter which adresses a few HTML 5 validation errors and warnings.

Docutils Tiny HTML Writer is another docutils html writer, with very light html output. It will create mainly for use in other project’s like doc generators or web publishers, which want 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 recommonmark from https://github.com/rtfd/recommonmark you can use md2html-tiny tool for MarkDown source codes.

Installation

~$ pip install docutils-tinyhtmlwriter

Project details


Release history Release notifications

This version
History Node

1.2.2

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
docutils-tinyhtmlwriter-fork-1.2.2.tar.gz (9.5 kB) Copy SHA256 hash SHA256 Source None Jul 25, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page