Added partial class listing, linking to API documentation

pagbada · May 21, 2013 · e8f84c1 · e8f84c1
1 parent 1364e00
commit e8f84c1
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/docs/index.rst b/docs/index.rst
@@ -66,7 +66,6 @@ Reference Guide
     * :doc:`ref/alternate-resource-return-values`
     * :doc:`ref/child-resources`
     * :doc:`ref/classes`
-      In which I list each class and link to its API documentation
 
 Api docs:
 ---------

diff --git a/docs/ref/classes.rst b/docs/ref/classes.rst
@@ -3,4 +3,23 @@
 Classes Available
 =================
 
+This is a partial list of classes only; for a full list of classes, `visit the
+API documentation <_static/phpdoc/index.html>`_.
+
+Classes below are linked to their API documentation. The classes listed are
+chosen because they are either directly discussed in this documentation, or
+because they may be of interest as extension points.
+
+- `ApiProblem <_static/phpdoc/classes/PhlyRestfully.ApiProblem.html>`_
+- `HalCollection <_static/phpdoc/classes/PhlyRestfully.HalCollection.html>`_
+- `HalResource <_static/phpdoc/classes/PhlyRestfully.HalResource.html>`_
+- `Link <_static/phpdoc/classes/PhlyRestfully.Link.html>`_
+- `LinkCollection <_static/phpdoc/classes/PhlyRestfully.LinkCollection.html>`_
+- `Metadata <_static/phpdoc/classes/PhlyRestfully.Metadata.html>`_
+- `MetadataMap <_static/phpdoc/classes/PhlyRestfully.MetadataMap.html>`_
+- `Resource <_static/phpdoc/classes/PhlyRestfully.Resource.html>`_
+- `ResourceController <_static/phpdoc/classes/PhlyRestfully.ResourceController.html>`_
+- `ResourceEvent <_static/phpdoc/classes/PhlyRestfully.ResourceEvent.html>`_
+- `HalLinks <_static/phpdoc/classes/PhlyRestfully.Plugin.HalLinks.html>`_
+
 .. index:: api-problem, HalLinks, controller, resource