Commit fb60b0d5 authored by jcwbacker's avatar jcwbacker
Browse files

Updated documentation files to include extract_metadata, feature_extractor,... 

Updated documentation files to include extract_metadata, feature_extractor, and matcher information in the project's web documentation.
parent b771cb1d

docs/conf.py

+2 −2
Original line number Diff line number Diff line
@@ -293,8 +293,8 @@ class Mock(MagicMock): 
    def __getter__(cls, name):

        return Mock()





MOCK_MODULES = ['proj4', 'numpy', 'pandas', 'scipy', 'osgeo']

# All imported libraries should be added to this mock modules list.

MOCK_MODULES = ['proj4', 'numpy', 'pandas', 'scipy', 'osgeo', 'cv2']

sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)



# NumpyDoc Options

docs/library/fileio/gdal.rst

+4 −1
Original line number Diff line number Diff line 
:mod:`fileio.io_gdal` --- Geospatial Data Abstraction Library

=============================================================



The :mod:`fileio.io_gdal` module provides a convenience wrapper to GDAL

The :mod:`fileio.io_gdal` and :mod:`fileio.extract_metadata` modules provide convenience wrappers to GDAL.



.. versionadded:: 0.1.0
@@ -9,3 +9,6 @@ The :mod:`fileio.io_gdal` module provides a convenience wrapper to GDAL 
   :synopsis: This is the synopsis

   :members:



.. automodule:: autocnet.fileio.extract_metadata

   :synopsis: This is the synopsis

   :members:

docs/library/matcher/feature_extractor.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
:mod:`matcher.feature_extractor` --- Extracting Features from Images

====================================================================



The :mod:`matcher.feature_extractor` module 



.. versionadded:: 0.1.0



.. automodule:: autocnet.matcher.feature_extractor

   :synopsis:

   :members:

docs/library/matcher/index.rst

+2 −1
Original line number Diff line number Diff line
@@ -3,4 +3,5 @@ 


.. toctree::



   nimage
 
   feature_extractor

   matcher

docs/library/matcher/matcher.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
:mod:`matcher.matcher` --- Matching Image Features

==================================================



The :mod:`matcher.matcher` module 



.. versionadded:: 0.1.0



.. automodule:: autocnet.matcher.matcher

   :synopsis:

   :members: