Merge pull request #548 from nontas/visualize_docs

Docs fixes for visualize, model, math and feature
menpo · Feb 5, 2015 · b228660 · b228660
2 parents cf643d3 + 657d28a
commit b228660
Show file tree

Hide file tree

Showing 26 changed files with 631 additions and 507 deletions.
diff --git a/docs/source/api/menpo/feature/double_igo.rst b/docs/source/api/menpo/feature/double_igo.rst
diff --git a/docs/source/api/menpo/feature/imgfeature.rst b/docs/source/api/menpo/feature/imgfeature.rst
diff --git a/docs/source/api/menpo/feature/index.rst b/docs/source/api/menpo/feature/index.rst
@@ -6,18 +6,21 @@
 .. toctree::
   :maxdepth: 1
 
-  lbp
+
+Features
+--------
+
+.. toctree::
+  :maxdepth: 1
+
   no_op
+  gradient
   gaussian_filter
-  double_igo
-  sparse_hog
+  igo
   es
+  lbp
   hog
-  gradient
-  igo
-  imgfeature
   daisy
-  ndfeature
 
 
 Widget

diff --git a/docs/source/api/menpo/feature/ndfeature.rst b/docs/source/api/menpo/feature/ndfeature.rst
diff --git a/docs/source/api/menpo/feature/sparse_hog.rst b/docs/source/api/menpo/feature/sparse_hog.rst
diff --git a/docs/source/api/menpo/shape/mean_pointcloud.rst b/docs/source/api/menpo/shape/mean_pointcloud.rst
@@ -4,5 +4,4 @@
 
 mean_pointcloud
 ===============
-
 .. autofunction:: mean_pointcloud
diff --git a/docs/source/api/menpo/visualize/AlignmentViewer2d.rst b/docs/source/api/menpo/visualize/AlignmentViewer2d.rst
diff --git a/docs/source/api/menpo/visualize/GraphPlotter.rst b/docs/source/api/menpo/visualize/GraphPlotter.rst
diff --git a/docs/source/api/menpo/visualize/index.rst b/docs/source/api/menpo/visualize/index.rst
@@ -19,16 +19,6 @@ Abstract Classes
   MatplotlibRenderer
 
 
-Viewers
--------
-
-.. toctree::
-  :maxdepth: 1
-
-  AlignmentViewer2d
-  GraphPlotter
-
-
 Widgets
 -------
 
@@ -43,11 +33,12 @@ Widgets
   save_matplotlib_figure
 
 
-Text Utils
-----------
+Print Utilities
+---------------
 
 .. toctree::
   :maxdepth: 1
 
   print_dynamic
   progress_bar_str
+  print_bytes
diff --git a/docs/source/api/menpo/visualize/print_bytes.rst b/docs/source/api/menpo/visualize/print_bytes.rst
@@ -0,0 +1,7 @@
+.. _menpo-visualize-print_bytes:
+
+.. currentmodule:: menpo.visualize
+
+print_bytes
+===========
+.. autofunction:: print_bytes
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,6 +50,9 @@ def __getattr__(cls, name):
 
 import menpo
 
+# add an up to date mathjax path
+mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
+
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

diff --git a/docs/xref_map.py b/docs/xref_map.py
@@ -16,7 +16,7 @@
 'Image': ('class', 'menpo.image.Image'),
 'image_paths': ('function', 'menpo.io.image_paths'),
 'ImageBoundaryError': ('class', 'menpo.image.ImageBoundaryError'),
-'ImageViewer': ('class', 'menpo.visualize.ImageViewer'),
+'InstanceBackedModel': ('class', 'menpo.model.instancebacked.InstanceBackedModel'),
 'Invertible': ('class', 'menpo.transform.Invertible'),
 'Landmarkable': ('class', 'menpo.landmark.Landmarkable'),
 'landmark_file_paths': ('function', 'menpo.io.landmark_file_paths'),
@@ -25,8 +25,9 @@
 'LabellingError': ('class', 'menpo.landmark.LabellingError'),
 'LinearModel': ('class', 'menpo.model.linear.LinearModel'),
 'MaskedImage': ('class', 'menpo.image.MaskedImage'),
-'MatplotlibRenderer': ('class', 'menpo.visualize.viewmatplotlib.MatplotlibRenderer'),
+'MatplotlibRenderer': ('class', 'menpo.visualize.MatplotlibRenderer'),
 'MeanInstanceLinearModel': ('class', 'menpo.model.MeanInstanceLinearModel'),
+'MeanLinearModel': ('class', 'menpo.model.linear.MeanLinearModel'),
 'MultipleAlignment': ('class', 'menpo.transform.MultipleAlignment'),
 'PCAModel': ('class', 'menpo.model.pca.PCAModel'),
 'PointCloud': ('class', 'menpo.shape.PointCloud'),
@@ -36,6 +37,7 @@
 'PointTree': ('class', 'menpo.shape.PointTree'),
 'PointUndirectedGraph': ('class', 'menpo.shape.PointUndirectedGraph'),
 'principal_component_decomposition': ('function', 'menpo.math.principal_component_decomposition'),
+'Renderer': ('class', 'menpo.visualize.Renderer'),
 'Rotation': ('class', 'menpo.shape.Rotation'),
 'Scale': ('class', 'menpo.shape.Scale'),
 'Shape': ('class', 'menpo.shape.Shape'),