diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 61 |
1 files changed, 16 insertions, 45 deletions
diff --git a/docs/index.rst b/docs/index.rst index 41da922..eabb7d7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,50 +1,21 @@ -======================= -Blessings API Reference -======================= +=================================== +Welcome to Blessings documentation! +=================================== -Read The Readme First -===================== +Contents: -This is the API documentation for the Blessings terminal library. +.. toctree:: + :maxdepth: 3 + :glob: -Because Blessings uses quite a bit of dynamism, you should -`read the readme first`_ for a general guide and overview. + intro + overview + api + history -However, if you're looking for the documentation of the internal -classes, their methods, and related functions that make up the -internals, you're in the right place. +======= +Indexes +======= -.. _`read the readme first`: http://pypi.python.org/pypi/blessings - -API Documentation -================= - -Internal modules are as follows. - -terminal module (primary) -------------------------- - -.. automodule:: blessings.terminal - :members: - :undoc-members: - -formatters module ------------------ - -.. automodule:: blessings.formatters - :members: - :undoc-members: - -keyboard module ---------------- - -.. automodule:: blessings.keyboard - :members: - :undoc-members: - -sequences module ----------------- - -.. automodule:: blessings.sequences - :members: - :undoc-members: +* :ref:`genindex` +* :ref:`modindex` |