Welcome to dirtywords's documentation!
======================================

.. include:: ../../README.rst

API Reference
=============

.. automodule:: dirtywords.base

The Core
--------

.. autoclass:: dirtywords.base.Core
    :members:

The Screen API
--------------

.. autoclass:: dirtywords.base.Screen
    :members:

.. autoclass:: dirtywords.Window
    :members:

Strings with Attributes
-----------------------

.. autoclass:: dirtywords.AttrString
    :members:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`