Metadata-Version: 1.1
Name: docutils-tinyhtmlwriter
Version: 1.3.0
Summary: Docutils Writer producing Tiny HTML
Home-page: https://github.com/ondratu/docutils-tinyhtmlwriter
Author: Ondřej Tůma (McBig)
Author-email: mcbig@zeropage.cz
License: BSD
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:
        
        .. code-block:: python
            :name: example
        
            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:
        
        .. code-block:: sh
        
            ~$ rst2html-tiny README.rst > README.html       # generate html from reStructured text
            ~$ rst2html-tiny -h                             # help output
        
        If you have installed `m2r <https://github.com/miyakogi/m2r>`_ package, you can
        use ``m2dhtml-tiny`` tool fro MarkDouwn source codes.
        
        
        Installation
        ------------
        .. code-block:: sh
        
            ~$ pip install docutils-tinyhtmlwriter
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Natural Language :: Czech
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Utilities
Requires: docutils (>= 0.12)
