Commits

Mike Graham committed d711019

Restructured docs

Comments (0)

Files changed (4)

+.. _apis:
+
+API documentation
+=================
+
+:mod:`remember.memoize`
+-----------------------
+
+.. automodule:: remember.memoize
+   :members:
+   :undoc-members:
+   
+   
+.. _dicts:
+  
+:mod:`remember.dicts`
+---------------------
+
+.. automodule:: remember.dicts
+   :members:
+   :undoc-members:

doc/dicts.rst

-.. _dicts:
-  
-:mod:`remember.dicts` API
-=========================
-
-.. automodule:: remember.dicts
-   :members:
-   :undoc-members:
    :maxdepth: 2
    
    usage.rst
-   memoize.rst
-   dicts.rst
+   apis.rst
    
 Description
-===========
+-----------
 Remember is a pure Python module for memoizing callables. It is able to store finite-sized caches of values to keep memory from being completely uncontrolled. 
 
 See the :ref:`Usage Guide <usage>` for more information.
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

doc/memoize.rst

-.. _memoize:
-
-:mod:`remember.memoize` API
-===========================
-
-.. automodule:: remember.memoize
-   :members:
-   :undoc-members:
-   
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.