Merge pull request #547 from patricksnape/docs

Image, Shape and User Guide Docs
menpo · Feb 5, 2015 · 894b4e0 · 894b4e0
2 parents b228660 + 4bb6d79
commit 894b4e0
Show file tree

Hide file tree

Showing 40 changed files with 1,889 additions and 783 deletions.
diff --git a/docs/source/_static/rtd_hack.css b/docs/source/_static/rtd_hack.css
@@ -1,11 +1,11 @@
 /* Code References (using the class or map commands) */
-a>code.xref.py.py-class.docutils.literal {
+a>code.xref.py.py-class.docutils.literal,a>code.xref.py.py-function.docutils.literal {
     color: #2980B9;
     font-weight: bold;
     padding: 0;
     font-size: 90%;
 }
-a:hover>code.xref.py.py-class.docutils.literal {
+a:hover>code.xref.py.py-class.docutils.literal,a:hover>code.xref.py.py-function.docutils.literal {
     color: purple;
 }
 /* Class names */

diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -2,6 +2,11 @@
 
 The Menpo API
 #############
+This section attempts to provide a simple browsing experience for the Menpo
+documentation. In Menpo, we use legible docstrings, and therefore, all
+documentation should be easily accessible in any sensible IDE (or IPython)
+via tab completion. However, this section should make most of the core
+classes available for viewing online.
 
 .. toctree::
   :maxdepth: 1

diff --git a/docs/source/api/menpo/image/Image.rst b/docs/source/api/menpo/image/Image.rst
@@ -8,3 +8,6 @@ Image
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/image/MaskedImage.rst b/docs/source/api/menpo/image/MaskedImage.rst
@@ -8,3 +8,6 @@ MaskedImage
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/ColouredTriMesh.rst b/docs/source/api/menpo/shape/ColouredTriMesh.rst
@@ -8,3 +8,6 @@ ColouredTriMesh
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/PointCloud.rst b/docs/source/api/menpo/shape/PointCloud.rst
@@ -8,3 +8,6 @@ PointCloud
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/PointDirectedGraph.rst b/docs/source/api/menpo/shape/PointDirectedGraph.rst
@@ -8,3 +8,6 @@ PointDirectedGraph
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/PointTree.rst b/docs/source/api/menpo/shape/PointTree.rst
@@ -8,3 +8,6 @@ PointTree
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/PointUndirectedGraph.rst b/docs/source/api/menpo/shape/PointUndirectedGraph.rst
@@ -8,3 +8,6 @@ PointUndirectedGraph
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/Shape.rst b/docs/source/api/menpo/shape/Shape.rst
@@ -0,0 +1,10 @@
+.. _menpo-shape-Shape:
+
+.. currentmodule:: menpo.shape.base
+
+Shape
+=====
+.. autoclass:: Shape
+  :members:
+  :inherited-members:
+  :show-inheritance:
diff --git a/docs/source/api/menpo/shape/TexturedTriMesh.rst b/docs/source/api/menpo/shape/TexturedTriMesh.rst
@@ -8,3 +8,6 @@ TexturedTriMesh
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/TriMesh.rst b/docs/source/api/menpo/shape/TriMesh.rst
@@ -8,3 +8,6 @@ TriMesh
   :members:
   :inherited-members:
   :show-inheritance:
+
+  .. automethod:: _view_2d
+  .. automethod:: _view_landmarks_2d
diff --git a/docs/source/api/menpo/shape/index.rst b/docs/source/api/menpo/shape/index.rst
@@ -3,9 +3,15 @@
 :mod:`menpo.shape`
 ==================
 
+
+Base Classes
+------------
+
 .. toctree::
   :maxdepth: 1
 
+  Shape
+
 
 PointCloud
 ----------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,23 +1,42 @@
 Welcome
 =======
+**Welcome to the Menpo documentation!**
 
-Welcome to Menpo's documentation.
+Menpo is a Python package designed to make manipulating annotated data more
+simple. In particular, sparse locations on either images or meshes, referred
+to as **landmarks** within Menpo, are tightly coupled with their reference
+objects. For areas such as Computer Vision that involve learning models
+based on prior knowledge of object location (such as object detection
+and landmark localisation), Menpo is a very powerful toolkit.
 
-If you are new to Menpo, we strongly recommend you check out the
-:ref:`User Guide <ug-introduction>`, which provides a broad overview of the project. After
-that you may wish to explore the
-`Menpo Notebooks <http://www.menpo.io/notebooks.html>`_, which give detailed
-examples for all aspects of Menpo that you can execute for yourself.
+A short example is often more illustrative than a verbose explanation. Let's
+assume that you want to load a set of images that have been annotated with
+bounding boxes, and that these bounding box locations live in text files
+next to the images. Here's how we would load the images and extract the
+areas within the bounding boxes using Menpo:
 
-Finally, Menpo's source is extensively documented. If you have a question about
-the behaviour of a particular class or function you should head to the the
-:ref:`api-index`.
+.. code-block:: python
 
-Contents
-========
+    import menpo.io as mio
+
+    images = []
+    for image in mio.import_images('./images_folder'):
+        image.crop_to_landmarks_inplace()
+        images.append(image)
+
+Where :map:`import_images` yields a generator to keep memory usage low.
+
+Although the above is a very simple example, we believe that being able
+to easily manipulate and couple landmarks with images *and* meshes, is an
+important problem for building powerful models in areas such as facial
+point localisation.
+
+To get started, check out the User Guide for instructions on installation
+and some of the core concepts within Menpo.
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
+  :hidden:
 
   userguide/index
   api/index