docify.lib package¶

Submodules¶

docify.lib.components module¶

class docify.lib.components.Text(value)[source]¶

Bases: docify.lib.components._Leaf

String objects are automatically wrapped into Text. So you don’t need to use it directly.

Parameters:	value (str) – String object to wrap.

Example:

Document('Some text', 'Some more text')
# Becomes: Document(Text('Some text'), Text('Some other text'))

class docify.lib.components.NoBreakSpace(**properties)[source]¶

Bases: docify.lib.components._Symbol

NoBreakSpace. Similar to  

class docify.lib.components.Break(**properties)[source]¶

Bases: docify.lib.components._Symbol

Break. Similar to <br />

class docify.lib.components.HorizontalRule(**properties)[source]¶

Bases: docify.lib.components._Symbol

HorizontalRule. Similar to <hr />

class docify.lib.components.Anchor(value, href, **kwargs)[source]¶

Bases: docify.lib.components._Leaf

Anchor. Similar to <a></a>.

Parameters:	value (str) – Text to display. href (str) – URL link.

Example usage:

Anchor('Some link', href='https://some.link.com')

class docify.lib.components.Image(src, alt, **kwargs)[source]¶

Bases: docify.lib.components._Leaf

Image. Similar to <img />.

Parameters:	src (str) – Source of image. alt (str) – Alternate text to display.

Example usage:

Image(src='https://some.source.com/someimage.png', alt='Some text')

class docify.lib.components.Header1(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header1. Similar to <h1></h1>

class docify.lib.components.Header2(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header2. Similar to <h2></h2>

class docify.lib.components.Header3(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header3. Similar to <h3></h3>

class docify.lib.components.Header4(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header4. Similar to <h4></h4>

class docify.lib.components.Header5(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header5. Similar to <h5></h5>

class docify.lib.components.Header6(*components, **kwargs)[source]¶

Bases: docify.lib.components._Header

Header6. Similar to <h6></h6>

class docify.lib.components.Footer(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Footer. Similar to <footer></footer>

class docify.lib.components.Small(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Small. Similar to <small></small>

class docify.lib.components.Cite(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Cite. Similar to <cite></cite>

class docify.lib.components.Italic(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Italic. Similar to <i></i>

class docify.lib.components.Bold(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Bold. Similar to <b></b>

class docify.lib.components.Blockquote(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Blockquote. Similar to <blockquote></blockquote>

class docify.lib.components.Pre(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Pre. Similar to <pre></pre>

class docify.lib.components.Code(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Code. Similar to <code></code>

class docify.lib.components.Del(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Del. Similar to <del></del>

class docify.lib.components.Section(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Section. Similar to <section></section>.

Example usage:

Section(
    I('Some text'),
    B('Some other text'))

class docify.lib.components.Paragraph(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Paragraph. Similar to <p></p>.

Example usage:

P(
    I('Some text'),
    Nbsp(),
    B('Some other text'))

class docify.lib.components.Span(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Span. Similar to <span></span>.

Example usage:

Span('Some text', 'Some other text')

class docify.lib.components.OrderedList(*components, **kwargs)[source]¶

Bases: docify.lib.components._List

OrderedList. Similar to <ol></ol>.

Example usage:

Ol(
    Li('item 1'),
    Li('item 2'),
    Ll(
        Li('item 2.1')))

class docify.lib.components.ListItem(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

ListItem. Similar to <li></li>. It should be used inside OrderedList and UnorderedList only.

class docify.lib.components.Table(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

Table. Similar to <table></table>.

Example usage:

Table(
    Tr(
        Th('header 1'),
        Th('header 2')),
    Tr(
        Td('value 1'),
        Td('value 2')))

class docify.lib.components.TableHeader(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

TableHeader. Similar to <thead></thead>

class docify.lib.components.TableRow(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

TableRow. Similar to <tr></tr>

class docify.lib.components.TableData(*components, **kwargs)[source]¶

Bases: docify.lib.components._Composite

TableData. Similar to <td></td>

docify.lib.components.Ol¶: alias of docify.lib.components.OrderedList

docify.lib.components.Ul¶: alias of docify.lib.components.UnorderedList

docify.lib.components.Hr¶: alias of docify.lib.components.HorizontalRule

docify.lib.components.Br¶: alias of docify.lib.components.Break

docify.lib.components.Img¶: alias of docify.lib.components.Image

docify.lib.components.A¶: alias of docify.lib.components.Anchor

docify.lib.components.Nbsp¶: alias of docify.lib.components.NoBreakSpace

docify.lib.components.Li¶: alias of docify.lib.components.ListItem

docify.lib.components.H1¶: alias of docify.lib.components.Header1

docify.lib.components.H2¶: alias of docify.lib.components.Header2

docify.lib.components.H3¶: alias of docify.lib.components.Header3

docify.lib.components.H4¶: alias of docify.lib.components.Header4

docify.lib.components.H5¶: alias of docify.lib.components.Header5

docify.lib.components.H6¶: alias of docify.lib.components.Header6

docify.lib.components.P¶: alias of docify.lib.components.Paragraph

docify.lib.components.B¶: alias of docify.lib.components.Bold

docify.lib.components.Strong¶: alias of docify.lib.components.Bold

docify.lib.components.I¶: alias of docify.lib.components.Italic

docify.lib.components.Em¶: alias of docify.lib.components.Italic

docify.lib.components.Th¶: alias of docify.lib.components.TableHeader

docify.lib.components.Tr¶: alias of docify.lib.components.TableRow

docify.lib.components.Td¶: alias of docify.lib.components.TableData

docify.lib.document module¶

class docify.lib.document.Document(*components)[source]¶

Bases: object

The core document object. It can be passed as input to different formatters which can parse it into various formats.

Parameters:	components (list) – Components to be added in the document.

Example usage:

doc = Document('Hail Docify!')

print(HTML(doc))
print(Markdown(doc))
print(Whatever(doc))

add(component)[source]¶

Adds a component in the doc.

Parameters:	component (Component) – Component to be added

docify.lib.formatter module¶

class docify.lib.formatter.Formatter(document, cite=True)[source]¶

Bases: object

Abstract class for formatter. Do not use it directly.

Parameters:	document (Document) – Document to format. cite (bool) – Whether to add the grumpy citation. Default is True.

Example usage:

class MyFormatter(Formatter):

    def update_handlers(self):
        super(MyFormatter, self).update_handlers()

        @self.handles(Span, Paragraph)
        def handle_span_and_paragraph(self, obj):
            return str(obj)

f(obj)¶

Parse and format an object using appropriate handler. If handler is not found, it will use str.

Parameters:	obj (Component\|Document) – Object to format.

format(obj)[source]¶

Parse and format an object using appropriate handler. If handler is not found, it will use str.

Parameters:	obj (Component\|Document) – Object to format.

handles(*items)[source]¶

Initializes decorator to register a handler for given items.

Parameters:	items (list) – List of items to handle.

render()[source]¶: Renders the formatted document. Called by __repr__.

update_handlers()[source]¶: Update handlers. Called by render() before performing format operation.

docify.lib package¶

Submodules¶

docify.lib.components module¶

docify.lib.document module¶

docify.lib.formatter module¶

Module contents¶

Docify

Navigation

Related Topics