dirtywords

commit

d3225cb9daa1013515555ed2f78e62813a4900e5

parent

1381fe8016564aca420e853b585c767599df2dd6

Author

Tobias Bengfort <tobias.bengfort@gmx.net>

Date

2014-10-07 19:38

join docs in single document

Diffstat

4 files changed, 28 insertions, 40 deletions

diff --git a/dirtywords/base.py b/dirtywords/base.py

@@ -11,6 +11,9 @@ A new core implementation should be derived from :py:class:`Screen` and
   11    11 must provide implementations for all low-level functions.  It may also provide
   12    12 optimised implementations of high-level functionality.
   13    13 
   -1    14 When importing directly from :py:mod:`dirtywords`, the "best" available
   -1    15 implementation is chosen.
   -1    16 
   14    17 """
   15    18 
   16    19 

diff --git a/docs/source/base.rst b/docs/source/base.rst

@@ -1,25 +0,0 @@
    1    -1 API Reference
    2    -1 =============
    3    -1 
    4    -1 .. automodule:: dirtywords.base
    5    -1 
    6    -1 The Core
    7    -1 --------
    8    -1 
    9    -1 .. autoclass:: dirtywords.base.Core
   10    -1     :members:
   11    -1 
   12    -1 The Screen API
   13    -1 --------------
   14    -1 
   15    -1 .. autoclass:: dirtywords.base.Screen
   16    -1     :members:
   17    -1 
   18    -1 .. autoclass:: dirtywords.Window
   19    -1     :members:
   20    -1 
   21    -1 Strings with Attributes
   22    -1 -----------------------
   23    -1 
   24    -1 .. autoclass:: dirtywords.AttrString
   25    -1     :members:

diff --git a/docs/source/index.rst b/docs/source/index.rst

@@ -1,18 +1,33 @@
    1    -1 .. dirtywords documentation master file, created by
    2    -1    sphinx-quickstart on Tue Oct  7 19:30:25 2014.
    3    -1    You can adapt this file completely to your liking, but it should at least
    4    -1    contain the root `toctree` directive.
    5    -1 
    6     1 Welcome to dirtywords's documentation!
    7     2 ======================================
    8     3 
    9    -1 Contents:
   -1     4 .. include:: ../../README.rst
   -1     5 
   -1     6 API Reference
   -1     7 =============
   -1     8 
   -1     9 .. automodule:: dirtywords.base
   -1    10 
   -1    11 The Core
   -1    12 --------
   -1    13 
   -1    14 .. autoclass:: dirtywords.base.Core
   -1    15     :members:
   10    16 
   11    -1 .. toctree::
   12    -1    quickstart
   13    -1    base
   14    -1    :maxdepth: 2
   -1    17 The Screen API
   -1    18 --------------
   15    19 
   -1    20 .. autoclass:: dirtywords.base.Screen
   -1    21     :members:
   -1    22 
   -1    23 .. autoclass:: dirtywords.Window
   -1    24     :members:
   -1    25 
   -1    26 Strings with Attributes
   -1    27 -----------------------
   -1    28 
   -1    29 .. autoclass:: dirtywords.AttrString
   -1    30     :members:
   16    31 
   17    32 
   18    33 Indices and tables
@@ -21,4 +36,3 @@ Indices and tables
   21    36 * :ref:`genindex`
   22    37 * :ref:`modindex`
   23    38 * :ref:`search`
   24    -1 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst

@@ -1,4 +0,0 @@
    1    -1 Quickstart
    2    -1 ==========
    3    -1 
    4    -1 .. include:: ../../README.rst