Documentation updates

AUTHORS.rst

@@ -1,6 +1,7 @@
-The following are a list of authors who have made substantial contributions to
+The following is a list of authors who have made substantial contributions to
 the conception or design of this software; or the creation of new code used in
-this software; or have drafted the work or substantively revised it:
+this software; or have drafted the work or substantively revised it and are
+considered "The vtkiorg Developers":
 
 - Alex Kaszynski, (`@akaszynski <https://github.com/akaszynski/>`_)
 - Bane Sullivan, (`@banesullivan <https://github.com/banesullivan/>`_)

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2017-2019 vtkiorg Developers
+Copyright (c) 2017-2019 The vtkiorg Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/authors.rst

@@ -7,3 +7,10 @@ Authors
 .. _authors_ref:
 
 .. include:: ../AUTHORS.rst
+
+
+
+License
+-------
+
+.. include:: ../LICENSE

docs/conf.py

@@ -51,7 +51,7 @@
 
 # General information about the project.
 project = u'vtki'
-copyright = u'2017-2019, vtkiorg Developers'
+copyright = u'2017-2019, The vtkiorg Developers'
 author = u'Alex Kaszynski and Bane Sullivan'
 
 # The version info for the project you're documenting, acts as replacement for

docs/external_examples.rst

@@ -9,18 +9,18 @@ Here are a list of longer, more technical examples of what ``vtki`` can do!
     If any of these links are broken, please raise an issue on the repository.
 
 
+Do you have a technical processing workflow or visualization routine you
+would like to share?
+If so, please consider sharing your work here by clicking the `Edit on GitHub`
+button at the top of this page and adding a link to your project!
+
+
 .. toctree::
    :maxdepth: 2
 
    3D visualization for the Open Mining Format (omf) <https://github.com/OpenGeoVis/omfvtk/blob/master/Example.ipynb>
+   Live example notebook showcasing omfvtk <https://mybinder.org/v2/gh/OpenGeoVis/omfvtk-demo/master?filepath=notebooks%2FExample.ipynb>
    3D Rendering with Discretize <http://discretize.simpeg.xyz/en/master/auto_examples/vtki_demo.html#sphx-glr-auto-examples-vtki-demo-py>
    OpenFOAM Rendering <https://pswpswpsw.github.io/posts/2018/09/blog-post-modify-vtk-openfoam/>
    FORGE Geothermal Project <http://forge.pvgeo.org>
-
-
-.. attention::
-
-   Do you have a technical processing workflow or visualization routine you
-   would like to share?
-   If so, please consider sharing your code here in the ``vtki`` documentation
-   by linking your example to this page!
+   PVGeo's example gallery <https://pvgeo.org/examples/index.html>

docs/index.rst

@@ -120,6 +120,25 @@ See :ref:`install_ref` for more details.
 
 
 
+Examples
+********
+
+Be sure to head over to the `examples gallery <./examples/index.html>`_
+to explore different use cases of ``vtki`` and to start visualizing 3D data in
+Pyhton! Also, please explore the list of external projects leveraging ``vtki``
+for 3D visualization in our `external examples list <./external_examples.html>`_
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Examples
+   :hidden:
+
+   examples/index
+   external_examples
+
+
+
 Data Types
 **********
 
@@ -143,22 +162,6 @@ side to help new users understand which data types to use.
    types/container
 
 
-Examples
-********
-
-Be sure to head over to the `examples gallery <./examples/index.html>`_
-to explore different use cases of ``vtki`` and to start visualizing 3D data in
-Pyhton!
-
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Examples
-   :hidden:
-
-   examples/index
-   external_examples
-
 
 Tools
 *****
@@ -181,6 +184,7 @@ Tools
    tools/utilities
 
 
+
 Contributing
 ************
 
@@ -202,11 +206,6 @@ contributing to ``vtki``, please see :ref:`contributing_ref`.
 
 
 
-License
-*******
-
-.. include:: ../LICENSE
-
 
 Project Index
 *************

docs/tools/utilities.rst

@@ -1,11 +1,30 @@
 Utilities
 =========
 
-
 .. automodule:: vtki.utilities
 
+.. autofunction:: vtki.set_error_output_file
+
+.. autofunction:: vtki.trans_from_matrix
+
+.. autofunction:: vtki.is_inside_bounds
+
+
+Object Conversions
+------------------
+
 .. autofunction:: vtki.wrap
 
+.. autofunction:: vtki.is_vtki_obj
+
+.. autofunction:: vtki.image_to_texture
+
+.. autofunction:: vtki.numpy_to_texture
+
+
+File IO
+-------
+
 .. autofunction:: vtki.read
 
 .. autofunction:: vtki.read_exodus
@@ -14,6 +33,10 @@ Utilities
 
 .. autofunction:: vtki.read_legacy
 
+
+Mesh Creation
+-------------
+
 .. autofunction:: vtki.lines_from_points
 
 .. autofunction:: vtki.vtk_points
@@ -22,6 +45,20 @@ Utilities
 
 .. autofunction:: vtki.fit_plane_to_points
 
-.. autofunction:: vtki.trans_from_matrix
 
-.. autofunction:: vtki.set_error_output_file
+Array Access
+------------
+
+.. autofunction:: vtki.get_scalar
+
+.. autofunction:: vtki.convert_array
+
+.. autofunction:: vtki.point_scalar
+
+.. autofunction:: vtki.cell_scalar
+
+.. autofunction:: vtki.get_vtk_type
+
+.. autofunction:: vtki.vtk_bit_array_to_char
+
+.. autofunction:: vtki.convert_string_array

vtki/pointset.py

@@ -644,7 +644,7 @@ def decimate_pro(self, reduction, feature_angle=45.0, split_angle=75.0, splittin
                      pre_split_mesh=False, preserve_topology=False, inplace=False):
         """Reduce the number of triangles in a triangular mesh, forming a good
         approximation to the original geometry. Based on the algorithm originally
-        described in "Decimation of Triangle Meshes", Proc Siggraph `92.
+        described in "Decimation of Triangle Meshes", Proc Siggraph 92.
 
         Parameters
         ----------

vtki/utilities.py

@@ -326,7 +326,8 @@ def wrap(vtkdataset):
 
 
 def image_to_texture(image):
-    """Converts ``vtkImageData`` to a ``vtkTexture``"""
+    """Converts ``vtkImageData`` (:class:`vtki.UniformGrid`) to a ``vtkTexture``
+    """
     vtex = vtk.vtkTexture()
     vtex.SetInputDataObject(image)
     vtex.Update()