wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-03 07:10:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Include auto-generated API files in distribution.

Browse Source
This commit is contained in:
Stefan van der Walt
2009-10-22 10:34:41 +02:00
parent 3b6a028c6b
commit d277058ff9
8 changed files with 280 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
MANIFEST.in
+1
View File
@@ -12,6 +12,7 @@ include CONTRIBUTORS.txt
# this at installation, only for sdist-generated tarballs
include doc/Makefile
recursive-include doc/source *
recursive-include doc/source/api *
recursive-include doc/tools *
recursive-include doc/ext *
TASKS.txt
+9
View File
@@ -94,6 +94,15 @@ Rework linear filters
* Kernel shape should be specifiable (currently defaults to image shape)
* Due to the above, the tests run unnecessarily slowly
API generation for source distribution
``````````````````````````````````````
The source package is currently distributed without the auto-generated API doc
sources. This means that users who download the source tar-file need to
install ``scikits.image`` before building docs. We can skirt the issue by
checking in the API files into the repository (done) -- but the doc build
process needs to be updated to use these distributed files if they cannot be
generated from source.
Development process
-------------------
* Go to `http://github.com/stefanv/scikits.image
doc/source/api/api.txt
+12
View File
@@ -0,0 +1,12 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
API Reference
=============
.. toctree::
scikits.image.color
scikits.image.filter
scikits.image.io
scikits.image.opencv
scikits.image.transform
doc/source/api/scikits.image.color.txt
+16
View File
@@ -0,0 +1,16 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
Module: :mod:`color`
====================
.. automodule:: scikits.image.color
.. currentmodule:: scikits.image.color
.. autosummary::
scikits.image.color.rgb2hsv
rgb2hsv
-------
.. autofunction:: scikits.image.color.rgb2hsv
doc/source/api/scikits.image.filter.txt
+39
View File
@@ -0,0 +1,39 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
Module: :mod:`filter`
=====================
Inheritance diagram for ``scikits.image.filter``:
.. inheritance-diagram:: scikits.image.filter
:parts: 3
.. automodule:: scikits.image.filter
.. currentmodule:: scikits.image.filter
:class:`LPIFilter2D`
--------------------
.. autoclass:: LPIFilter2D
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
.. automethod:: __init__
.. autosummary::
scikits.image.filter.inverse
scikits.image.filter.wiener
inverse
-------
.. autofunction:: scikits.image.filter.inverse
wiener
------
.. autofunction:: scikits.image.filter.wiener
doc/source/api/scikits.image.io.txt
+57
View File
@@ -0,0 +1,57 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
Module: :mod:`io`
=================
Inheritance diagram for ``scikits.image.io``:
.. inheritance-diagram:: scikits.image.io
:parts: 3
.. automodule:: scikits.image.io
.. currentmodule:: scikits.image.io
:class:`ImageCollection`
------------------------
.. autoclass:: ImageCollection
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
.. automethod:: __init__
:class:`MultiImage`
-------------------
.. autoclass:: MultiImage
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
.. automethod:: __init__
.. autosummary::
scikits.image.io.imread
scikits.image.io.load_sift
scikits.image.io.load_surf
imread
------
.. autofunction:: scikits.image.io.imread
load_sift
---------
.. autofunction:: scikits.image.io.load_sift
load_surf
---------
.. autofunction:: scikits.image.io.load_surf
doc/source/api/scikits.image.opencv.txt
+112
View File
@@ -0,0 +1,112 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
Module: :mod:`opencv`
=====================
.. automodule:: scikits.image.opencv
.. currentmodule:: scikits.image.opencv
.. autosummary::
scikits.image.opencv.cvCanny
scikits.image.opencv.cvCornerEigenValsAndVecs
scikits.image.opencv.cvCornerHarris
scikits.image.opencv.cvCornerMinEigenVal
scikits.image.opencv.cvDrawChessboardCorners
scikits.image.opencv.cvFindChessboardCorners
scikits.image.opencv.cvFindCornerSubPix
scikits.image.opencv.cvGetQuadrangleSubPix
scikits.image.opencv.cvGetRectSubPix
scikits.image.opencv.cvGoodFeaturesToTrack
scikits.image.opencv.cvLaplace
scikits.image.opencv.cvPreCornerDetect
scikits.image.opencv.cvResize
scikits.image.opencv.cvSmooth
scikits.image.opencv.cvSobel
scikits.image.opencv.cvWarpAffine
scikits.image.opencv.cvWarpPerspective
cvCanny
-------
.. autofunction:: scikits.image.opencv.cvCanny
cvCornerEigenValsAndVecs
------------------------
.. autofunction:: scikits.image.opencv.cvCornerEigenValsAndVecs
cvCornerHarris
--------------
.. autofunction:: scikits.image.opencv.cvCornerHarris
cvCornerMinEigenVal
-------------------
.. autofunction:: scikits.image.opencv.cvCornerMinEigenVal
cvDrawChessboardCorners
-----------------------
.. autofunction:: scikits.image.opencv.cvDrawChessboardCorners
cvFindChessboardCorners
-----------------------
.. autofunction:: scikits.image.opencv.cvFindChessboardCorners
cvFindCornerSubPix
------------------
.. autofunction:: scikits.image.opencv.cvFindCornerSubPix
cvGetQuadrangleSubPix
---------------------
.. autofunction:: scikits.image.opencv.cvGetQuadrangleSubPix
cvGetRectSubPix
---------------
.. autofunction:: scikits.image.opencv.cvGetRectSubPix
cvGoodFeaturesToTrack
---------------------
.. autofunction:: scikits.image.opencv.cvGoodFeaturesToTrack
cvLaplace
---------
.. autofunction:: scikits.image.opencv.cvLaplace
cvPreCornerDetect
-----------------
.. autofunction:: scikits.image.opencv.cvPreCornerDetect
cvResize
--------
.. autofunction:: scikits.image.opencv.cvResize
cvSmooth
--------
.. autofunction:: scikits.image.opencv.cvSmooth
cvSobel
-------
.. autofunction:: scikits.image.opencv.cvSobel
cvWarpAffine
------------
.. autofunction:: scikits.image.opencv.cvWarpAffine
cvWarpPerspective
-----------------
.. autofunction:: scikits.image.opencv.cvWarpPerspective
doc/source/api/scikits.image.transform.txt
+34
View File
@@ -0,0 +1,34 @@
.. AUTO-GENERATED FILE -- DO NOT EDIT!
Module: :mod:`transform`
========================
.. automodule:: scikits.image.transform
.. currentmodule:: scikits.image.transform
.. autosummary::
scikits.image.transform.frt2
scikits.image.transform.homography
scikits.image.transform.hough
scikits.image.transform.ifrt2
frt2
----
.. autofunction:: scikits.image.transform.frt2
homography
----------
.. autofunction:: scikits.image.transform.homography
hough
-----
.. autofunction:: scikits.image.transform.hough
ifrt2
-----
.. autofunction:: scikits.image.transform.ifrt2