karney._common
==============

.. py:module:: karney._common


Attributes
----------

.. autoapisummary::

   karney._common.HAVE_INDENT
   karney._common.dedent


Functions
---------

.. autoapisummary::

   karney._common.indent
   karney._common._get_h1line
   karney._common._make_summary
   karney._common.use_docstring_from
   karney._common.use_docstring
   karney._common.test_docstrings
   karney._common.write_readme


Module Contents
---------------

.. py:data:: HAVE_INDENT

.. py:function:: indent(text, amount=4, ch=' ')

.. py:data:: dedent

.. py:function:: _get_h1line(object_)

   Returns the H1 line of the documentation of an object.


.. py:function:: _make_summary(odict)

   Return summary of all functions and classes in odict


.. py:function:: use_docstring_from(cls)

   This decorator modifies the decorated function's docstring by
   with the docstring from the class `cls`.

   If the function's docstring is None it is replaced with the supplied cls.__doc__.
   otherwise it is set to old_docstring.format(super=cls.__doc__)

   This is useful when you want to reuse the docstring from another class or
   if you want modify the docstring of a function at runtime.



.. py:function:: use_docstring(docstring)

   This decorator modifies the decorated function's docstring with supplied docstring.

   If the function's docstring is None it is replaced with the supplied docstring.
   otherwise it is set to old_docstring.format(super=docstring)

   This is useful when you want modify the docstring of a function at runtime.


.. py:function:: test_docstrings(filename)

.. py:function:: write_readme(doc)