****************************
A Lorem Ipsum text generator
****************************

:version: |version|
:author: |author|
:contact: |contact|
:copyright: |copyright|

.. include:: ../LICENSE.rst

Overview
========

.. include:: ../README.rst

.. include:: ../HISTORY.rst

.. include:: ../CHANGES.rst

***
API
***

Basic usage
===========

.. automodule:: loremipsum

Exceptions
==========

.. autoexception:: loremipsum.SampleError

.. autoexception:: loremipsum.DictionaryError

Functions
=========

.. autofunction:: generate_sentence

.. autofunction:: generate_sentences

.. autofunction:: generate_paragraph

.. autofunction:: generate_paragraphs

.. autofunction:: get_sentence

.. autofunction:: get_sentences

.. autofunction:: get_paragraph

.. autofunction:: get_paragraphs

The Generator class
===================

.. autoclass:: loremipsum.Generator
   :members: 

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

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