[python-arrayfire] 02/08: Files required to generate documentation
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Fri Sep 16 09:30:04 UTC 2016
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to branch master
in repository python-arrayfire.
commit 76c173ae27a6a3a749a90dc6eb2ca18bc2b5e79f
Author: Pavan Yalamanchili <pavan at arrayfire.com>
Date: Fri Jun 24 20:46:47 2016 -0400
Files required to generate documentation
---
arrayfire/__init__.py | 33 ++--
arrayfire/algorithm.py | 4 +-
arrayfire/arith.py | 2 +-
arrayfire/array.py | 16 +-
arrayfire/blas.py | 2 +-
arrayfire/data.py | 6 +-
arrayfire/device.py | 6 +-
arrayfire/features.py | 2 +-
arrayfire/graphics.py | 2 +-
arrayfire/image.py | 2 +-
arrayfire/index.py | 2 +-
arrayfire/interop.py | 1 +
arrayfire/lapack.py | 2 +-
arrayfire/library.py | 2 +-
arrayfire/signal.py | 2 +-
arrayfire/statistics.py | 4 +
arrayfire/timer.py | 2 +-
arrayfire/util.py | 4 +
arrayfire/vision.py | 2 +-
docs/Makefile | 225 +++++++++++++++++++++++++++
docs/arrayfire.algorithm.rst | 7 +
docs/arrayfire.arith.rst | 7 +
docs/arrayfire.array.rst | 7 +
docs/arrayfire.base.rst | 7 +
docs/arrayfire.bcast.rst | 7 +
docs/arrayfire.blas.rst | 7 +
docs/arrayfire.cuda.rst | 7 +
docs/arrayfire.data.rst | 7 +
docs/arrayfire.device.rst | 7 +
docs/arrayfire.features.rst | 7 +
docs/arrayfire.graphics.rst | 7 +
docs/arrayfire.image.rst | 7 +
docs/arrayfire.index.rst | 7 +
docs/arrayfire.interop.rst | 7 +
docs/arrayfire.lapack.rst | 7 +
docs/arrayfire.library.rst | 7 +
docs/arrayfire.opencl.rst | 7 +
docs/arrayfire.rst | 34 ++++
docs/arrayfire.signal.rst | 7 +
docs/arrayfire.statistics.rst | 7 +
docs/arrayfire.timer.rst | 7 +
docs/arrayfire.util.rst | 7 +
docs/arrayfire.vision.rst | 7 +
docs/arrayfire_logo_symbol.png | Bin 0 -> 35688 bytes
docs/conf.py | 341 +++++++++++++++++++++++++++++++++++++++++
docs/index.rst | 1 +
docs/make.bat | 281 +++++++++++++++++++++++++++++++++
docs/modules.rst | 7 +
48 files changed, 1102 insertions(+), 37 deletions(-)
diff --git a/arrayfire/__init__.py b/arrayfire/__init__.py
index 40cc231..bd7617f 100644
--- a/arrayfire/__init__.py
+++ b/arrayfire/__init__.py
@@ -8,18 +8,22 @@
########################################################
"""
-A high performance scientific computing library for CUDA, OpenCL and CPU devices.
+ArrayFire is a high performance scientific computing library with an easy to use API.
-The functionality provided by ArrayFire spans the following domains:
- 1. Vector Algorithms
- 2. Image Processing
- 3. Signal Processing
- 4. Computer Vision
- 5. Linear Algebra
- 6. Statistics
+ >>> # Monte Carlo estimation of pi
+ >>> def calc_pi_device(samples):
+ # Simple, array based API
+ # Generate uniformly distributed random numers
+ x = af.randu(samples)
+ y = af.randu(samples)
+ # Supports Just In Time Compilation
+ # The following line generates a single kernel
+ within_unit_circle = (x * x + y * y) < 1
+ # Intuitive function names
+ return 4 * af.count(within_unit_circle) / samples
-Programs written using ArrayFire are portable across CUDA, OpenCL and CPU devices
+Programs written using ArrayFire are portable across CUDA, OpenCL and CPU devices.
The default backend is chosen in the following order of preference based on the available libraries:
@@ -31,7 +35,16 @@ The backend can be chosen at the beginning of the program by using the following
>>> af.backend.set(name)
-where name is one of 'cuda', 'opencl' or 'cpu'
+where name is one of 'cuda', 'opencl' or 'cpu'.
+
+The functionality provided by ArrayFire spans the following domains:
+
+ 1. Vector Algorithms
+ 2. Image Processing
+ 3. Signal Processing
+ 4. Computer Vision
+ 5. Linear Algebra
+ 6. Statistics
"""
diff --git a/arrayfire/algorithm.py b/arrayfire/algorithm.py
index 8236637..6701d96 100644
--- a/arrayfire/algorithm.py
+++ b/arrayfire/algorithm.py
@@ -8,7 +8,7 @@
########################################################
"""
-Vector algorithms for ArrayFire
+Vector algorithms (sum, min, sort, etc).
"""
from .library import *
@@ -283,7 +283,7 @@ def imax(a, dim=None):
def accum(a, dim=0):
"""
- Cumulative sum of an array along a specified dimension.
+ Cumulative sum of an array along a specified dimension
Parameters
----------
diff --git a/arrayfire/arith.py b/arrayfire/arith.py
index 9dc8c66..4c73e59 100644
--- a/arrayfire/arith.py
+++ b/arrayfire/arith.py
@@ -8,7 +8,7 @@
########################################################
"""
-Math functions for ArrayFire
+Math functions (sin, sqrt, exp, etc).
"""
from .library import *
diff --git a/arrayfire/array.py b/arrayfire/array.py
index 327fd6b..ede0da0 100644
--- a/arrayfire/array.py
+++ b/arrayfire/array.py
@@ -8,7 +8,7 @@
########################################################
"""
-arrayfire.Array class and helper functions.
+Array class and helper functions.
"""
import inspect
@@ -488,7 +488,7 @@ class Array(BaseArray):
Return the device pointer exclusively held by the array.
Returns
- ------
+ --------
ptr : int
Contains location of the device pointer
@@ -508,7 +508,7 @@ class Array(BaseArray):
Return the device pointer held by the array.
Returns
- ------
+ --------
ptr : int
Contains location of the device pointer
@@ -529,7 +529,7 @@ class Array(BaseArray):
Return the offset, of the first element relative to the raw pointer.
Returns
- ------
+ --------
offset : int
The offset in number of elements
"""
@@ -542,7 +542,7 @@ class Array(BaseArray):
Return the distance in bytes between consecutive elements for each dimension.
Returns
- ------
+ --------
strides : tuple
The strides for each dimension
"""
@@ -1078,7 +1078,7 @@ class Array(BaseArray):
Return the data as a ctype C array after copying to host memory
Parameters
- ---------
+ -----------
row_major: optional: bool. default: False.
Specifies if a transpose needs to occur before copying to host memory.
@@ -1112,7 +1112,7 @@ class Array(BaseArray):
Return the data as array.array
Parameters
- ---------
+ -----------
row_major: optional: bool. default: False.
Specifies if a transpose needs to occur before copying to host memory.
@@ -1147,7 +1147,7 @@ class Array(BaseArray):
Return the data as list
Parameters
- ---------
+ -----------
row_major: optional: bool. default: False.
Specifies if a transpose needs to occur before copying to host memory.
diff --git a/arrayfire/blas.py b/arrayfire/blas.py
index c476c1c..a3774f1 100644
--- a/arrayfire/blas.py
+++ b/arrayfire/blas.py
@@ -8,7 +8,7 @@
########################################################
"""
-BLAS functions for arrayfire.
+BLAS functions (matmul, dot, etc)
"""
from .library import *
diff --git a/arrayfire/data.py b/arrayfire/data.py
index 2e6c9fc..0df045f 100644
--- a/arrayfire/data.py
+++ b/arrayfire/data.py
@@ -384,7 +384,7 @@ def join(dim, first, second, third=None, fourth=None):
An array containing the input arrays joined along the specified dimension.
Examples
- -------
+ ---------
>>> import arrayfire as af
>>> a = af.randu(2, 3)
@@ -460,7 +460,7 @@ def tile(a, d0, d1=1, d2=1, d3=1):
An array containing the input after tiling the the specified number of times.
Examples
- -------
+ ---------
>>> import arrayfire as af
>>> a = af.randu(2, 3)
@@ -710,7 +710,7 @@ def flip(a, dim=0):
The output after flipping `a` along `dim`.
Examples
- -------
+ ---------
>>> import arrayfire as af
>>> a = af.randu(3, 3)
diff --git a/arrayfire/device.py b/arrayfire/device.py
index 6336ea7..0a30385 100644
--- a/arrayfire/device.py
+++ b/arrayfire/device.py
@@ -76,7 +76,7 @@ def set_device(num):
Change the active device to the specified id.
Parameters
- ---------
+ -----------
num: int.
id of the desired device.
"""
@@ -136,7 +136,7 @@ def is_dbl_supported(device=None):
Check if double precision is supported on specified device.
Parameters
- ---------
+ -----------
device: optional: int. default: None.
id of the desired device.
@@ -155,7 +155,7 @@ def sync(device=None):
Block until all the functions on the device have completed execution.
Parameters
- ---------
+ -----------
device: optional: int. default: None.
id of the desired device.
"""
diff --git a/arrayfire/features.py b/arrayfire/features.py
index 04f725f..d21471a 100644
--- a/arrayfire/features.py
+++ b/arrayfire/features.py
@@ -7,7 +7,7 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
"""
-arrayfire.Features class
+Features class used for Computer Vision algorithms.
"""
from .library import *
from .array import *
diff --git a/arrayfire/graphics.py b/arrayfire/graphics.py
index ef5ef09..3d0b3f2 100644
--- a/arrayfire/graphics.py
+++ b/arrayfire/graphics.py
@@ -8,7 +8,7 @@
########################################################
"""
-graphics functions for arrayfire
+Graphics functions (plot, image, etc).
"""
from .library import *
diff --git a/arrayfire/image.py b/arrayfire/image.py
index ec68f8a..ac4b8ed 100644
--- a/arrayfire/image.py
+++ b/arrayfire/image.py
@@ -8,7 +8,7 @@
########################################################
"""
-Image processing functions for arrayfire.
+Image processing functions.
"""
from .library import *
diff --git a/arrayfire/index.py b/arrayfire/index.py
index baad324..a23e2e2 100644
--- a/arrayfire/index.py
+++ b/arrayfire/index.py
@@ -7,7 +7,7 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
"""
-classes required for indexing operations
+Index and Seq classes used in indexing operations.
"""
from .library import *
diff --git a/arrayfire/interop.py b/arrayfire/interop.py
index e512b75..44858e8 100644
--- a/arrayfire/interop.py
+++ b/arrayfire/interop.py
@@ -14,6 +14,7 @@ This module provides interoperability with the following python packages.
1. numpy
2. pycuda
+ 3. pyopencl
"""
from .array import *
diff --git a/arrayfire/lapack.py b/arrayfire/lapack.py
index 346cddb..161b1ee 100644
--- a/arrayfire/lapack.py
+++ b/arrayfire/lapack.py
@@ -8,7 +8,7 @@
########################################################
"""
-Dense Linear Algebra functions for arrayfire.
+Dense Linear Algebra functions (solve, inverse, etc).
"""
from .library import *
diff --git a/arrayfire/library.py b/arrayfire/library.py
index 822d75a..ff09f05 100644
--- a/arrayfire/library.py
+++ b/arrayfire/library.py
@@ -8,7 +8,7 @@
########################################################
"""
-module containing enums and other constants from arrayfire library
+Module containing enums and other constants.
"""
import platform
diff --git a/arrayfire/signal.py b/arrayfire/signal.py
index f201a23..fe377ed 100644
--- a/arrayfire/signal.py
+++ b/arrayfire/signal.py
@@ -8,7 +8,7 @@
########################################################
"""
-signal processing functions for arrayfire.
+Signal processing functions (fft, convolve, etc).
"""
from .library import *
diff --git a/arrayfire/statistics.py b/arrayfire/statistics.py
index 597dc68..d953369 100644
--- a/arrayfire/statistics.py
+++ b/arrayfire/statistics.py
@@ -7,6 +7,10 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
+"""
+Statistical algorithms (mean, var, stdev, etc).
+"""
+
from .library import *
from .array import *
diff --git a/arrayfire/timer.py b/arrayfire/timer.py
index 6f6c3ef..d523fcd 100644
--- a/arrayfire/timer.py
+++ b/arrayfire/timer.py
@@ -7,7 +7,7 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
"""
-Functions to time arrayfire functions
+Functions to time arrayfire.
"""
from .library import *
diff --git a/arrayfire/util.py b/arrayfire/util.py
index a610fa9..fe3e225 100644
--- a/arrayfire/util.py
+++ b/arrayfire/util.py
@@ -7,6 +7,10 @@
# http://arrayfire.com/licenses/BSD-3-Clause
########################################################
+"""
+Utility functions to help with Array metadata.
+"""
+
from .library import *
import numbers
diff --git a/arrayfire/vision.py b/arrayfire/vision.py
index 6cc6914..9598a6b 100644
--- a/arrayfire/vision.py
+++ b/arrayfire/vision.py
@@ -8,7 +8,7 @@
########################################################
"""
-Computer vision functions for arrayfire.
+Computer vision functions (FAST, ORB, etc)
"""
from .library import *
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..45690fe
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,225 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " epub3 to make an epub3"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+ @echo " dummy to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ArrayFire.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ArrayFire.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/ArrayFire"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ArrayFire"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+ $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+ @echo
+ @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+ $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+ @echo
+ @echo "Build finished. Dummy builder generates no files."
diff --git a/docs/arrayfire.algorithm.rst b/docs/arrayfire.algorithm.rst
new file mode 100644
index 0000000..e410929
--- /dev/null
+++ b/docs/arrayfire.algorithm.rst
@@ -0,0 +1,7 @@
+arrayfire.algorithm module
+==========================
+
+.. automodule:: arrayfire.algorithm
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.arith.rst b/docs/arrayfire.arith.rst
new file mode 100644
index 0000000..d874a2e
--- /dev/null
+++ b/docs/arrayfire.arith.rst
@@ -0,0 +1,7 @@
+arrayfire.arith module
+======================
+
+.. automodule:: arrayfire.arith
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.array.rst b/docs/arrayfire.array.rst
new file mode 100644
index 0000000..84e3351
--- /dev/null
+++ b/docs/arrayfire.array.rst
@@ -0,0 +1,7 @@
+arrayfire.array module
+======================
+
+.. automodule:: arrayfire.array
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.base.rst b/docs/arrayfire.base.rst
new file mode 100644
index 0000000..be1e420
--- /dev/null
+++ b/docs/arrayfire.base.rst
@@ -0,0 +1,7 @@
+arrayfire.base module
+=====================
+
+.. automodule:: arrayfire.base
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.bcast.rst b/docs/arrayfire.bcast.rst
new file mode 100644
index 0000000..0bcd4e5
--- /dev/null
+++ b/docs/arrayfire.bcast.rst
@@ -0,0 +1,7 @@
+arrayfire.bcast module
+======================
+
+.. automodule:: arrayfire.bcast
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.blas.rst b/docs/arrayfire.blas.rst
new file mode 100644
index 0000000..054f98f
--- /dev/null
+++ b/docs/arrayfire.blas.rst
@@ -0,0 +1,7 @@
+arrayfire.blas module
+=====================
+
+.. automodule:: arrayfire.blas
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.cuda.rst b/docs/arrayfire.cuda.rst
new file mode 100644
index 0000000..f0f3a48
--- /dev/null
+++ b/docs/arrayfire.cuda.rst
@@ -0,0 +1,7 @@
+arrayfire.cuda module
+=====================
+
+.. automodule:: arrayfire.cuda
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.data.rst b/docs/arrayfire.data.rst
new file mode 100644
index 0000000..de208ff
--- /dev/null
+++ b/docs/arrayfire.data.rst
@@ -0,0 +1,7 @@
+arrayfire.data module
+=====================
+
+.. automodule:: arrayfire.data
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.device.rst b/docs/arrayfire.device.rst
new file mode 100644
index 0000000..ad98bf6
--- /dev/null
+++ b/docs/arrayfire.device.rst
@@ -0,0 +1,7 @@
+arrayfire.device module
+=======================
+
+.. automodule:: arrayfire.device
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.features.rst b/docs/arrayfire.features.rst
new file mode 100644
index 0000000..44629c6
--- /dev/null
+++ b/docs/arrayfire.features.rst
@@ -0,0 +1,7 @@
+arrayfire.features module
+=========================
+
+.. automodule:: arrayfire.features
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.graphics.rst b/docs/arrayfire.graphics.rst
new file mode 100644
index 0000000..3a1505e
--- /dev/null
+++ b/docs/arrayfire.graphics.rst
@@ -0,0 +1,7 @@
+arrayfire.graphics module
+=========================
+
+.. automodule:: arrayfire.graphics
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.image.rst b/docs/arrayfire.image.rst
new file mode 100644
index 0000000..d4934b4
--- /dev/null
+++ b/docs/arrayfire.image.rst
@@ -0,0 +1,7 @@
+arrayfire.image module
+======================
+
+.. automodule:: arrayfire.image
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.index.rst b/docs/arrayfire.index.rst
new file mode 100644
index 0000000..95c3dcd
--- /dev/null
+++ b/docs/arrayfire.index.rst
@@ -0,0 +1,7 @@
+arrayfire.index module
+======================
+
+.. automodule:: arrayfire.index
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.interop.rst b/docs/arrayfire.interop.rst
new file mode 100644
index 0000000..f7886aa
--- /dev/null
+++ b/docs/arrayfire.interop.rst
@@ -0,0 +1,7 @@
+arrayfire.interop module
+========================
+
+.. automodule:: arrayfire.interop
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.lapack.rst b/docs/arrayfire.lapack.rst
new file mode 100644
index 0000000..4f14e4c
--- /dev/null
+++ b/docs/arrayfire.lapack.rst
@@ -0,0 +1,7 @@
+arrayfire.lapack module
+=======================
+
+.. automodule:: arrayfire.lapack
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.library.rst b/docs/arrayfire.library.rst
new file mode 100644
index 0000000..6c9c78d
--- /dev/null
+++ b/docs/arrayfire.library.rst
@@ -0,0 +1,7 @@
+arrayfire.library module
+========================
+
+.. automodule:: arrayfire.library
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.opencl.rst b/docs/arrayfire.opencl.rst
new file mode 100644
index 0000000..b4622b3
--- /dev/null
+++ b/docs/arrayfire.opencl.rst
@@ -0,0 +1,7 @@
+arrayfire.opencl module
+=======================
+
+.. automodule:: arrayfire.opencl
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.rst b/docs/arrayfire.rst
new file mode 100644
index 0000000..2ccfd3b
--- /dev/null
+++ b/docs/arrayfire.rst
@@ -0,0 +1,34 @@
+ArrayFire Python Wrapper
+========================
+
+Introduction
+---------------
+
+.. automodule:: arrayfire
+
+ Submodules
+----------
+
+.. autosummary::
+ arrayfire.algorithm
+ arrayfire.arith
+ arrayfire.array
+ arrayfire.base
+ arrayfire.bcast
+ arrayfire.blas
+ arrayfire.cuda
+ arrayfire.data
+ arrayfire.device
+ arrayfire.features
+ arrayfire.graphics
+ arrayfire.image
+ arrayfire.index
+ arrayfire.interop
+ arrayfire.lapack
+ arrayfire.library
+ arrayfire.opencl
+ arrayfire.signal
+ arrayfire.statistics
+ arrayfire.timer
+ arrayfire.util
+ arrayfire.vision
diff --git a/docs/arrayfire.signal.rst b/docs/arrayfire.signal.rst
new file mode 100644
index 0000000..ae06fdf
--- /dev/null
+++ b/docs/arrayfire.signal.rst
@@ -0,0 +1,7 @@
+arrayfire.signal module
+=======================
+
+.. automodule:: arrayfire.signal
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.statistics.rst b/docs/arrayfire.statistics.rst
new file mode 100644
index 0000000..a20ef21
--- /dev/null
+++ b/docs/arrayfire.statistics.rst
@@ -0,0 +1,7 @@
+arrayfire.statistics module
+===========================
+
+.. automodule:: arrayfire.statistics
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.timer.rst b/docs/arrayfire.timer.rst
new file mode 100644
index 0000000..cb9cac2
--- /dev/null
+++ b/docs/arrayfire.timer.rst
@@ -0,0 +1,7 @@
+arrayfire.timer module
+======================
+
+.. automodule:: arrayfire.timer
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.util.rst b/docs/arrayfire.util.rst
new file mode 100644
index 0000000..c5192ae
--- /dev/null
+++ b/docs/arrayfire.util.rst
@@ -0,0 +1,7 @@
+arrayfire.util module
+=====================
+
+.. automodule:: arrayfire.util
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire.vision.rst b/docs/arrayfire.vision.rst
new file mode 100644
index 0000000..d2f229a
--- /dev/null
+++ b/docs/arrayfire.vision.rst
@@ -0,0 +1,7 @@
+arrayfire.vision module
+=======================
+
+.. automodule:: arrayfire.vision
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/arrayfire_logo_symbol.png b/docs/arrayfire_logo_symbol.png
new file mode 100644
index 0000000..7a2476d
Binary files /dev/null and b/docs/arrayfire_logo_symbol.png differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..0493788
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,341 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# ArrayFire documentation build configuration file, created by
+# sphinx-quickstart on Fri Jun 24 20:20:43 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+from __af_version__ import full_version
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.mathjax',
+ 'sphinx.ext.viewcode',
+ 'numpydoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.inheritance_diagram']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'ArrayFire'
+copyright = '2016, Pavan Yalamanchili'
+author = 'Pavan Yalamanchili'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = full_version
+# The full version, including alpha/beta/rc tags.
+release = full_version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+html_title = 'ArrayFire Python documentation'
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+html_logo = "arrayfire_logo_symbol.png"
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ArrayFiredoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'ArrayFire.tex', 'ArrayFire Documentation',
+ 'Pavan Yalamanchili', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'arrayfire', 'ArrayFire Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'ArrayFire', 'ArrayFire Documentation',
+ author, 'ArrayFire', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
diff --git a/docs/index.rst b/docs/index.rst
new file mode 120000
index 0000000..4c689ce
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1 @@
+arrayfire.rst
\ No newline at end of file
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..1b46d26
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,281 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. epub3 to make an epub3
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ echo. coverage to run coverage check of the documentation if enabled
+ echo. dummy to check syntax errors of document sources
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 1>NUL 2>NUL
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+:sphinx_ok
+
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ArrayFire.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ArrayFire.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "epub3" (
+ %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdf" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdfja" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf-ja
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+if "%1" == "coverage" (
+ %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+ goto end
+)
+
+if "%1" == "xml" (
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
+ goto end
+)
+
+if "%1" == "pseudoxml" (
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+ goto end
+)
+
+if "%1" == "dummy" (
+ %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. Dummy builder generates no files.
+ goto end
+)
+
+:end
diff --git a/docs/modules.rst b/docs/modules.rst
new file mode 100644
index 0000000..c5f5de8
--- /dev/null
+++ b/docs/modules.rst
@@ -0,0 +1,7 @@
+arrayfire
+=========
+
+.. toctree::
+ :maxdepth: 4
+
+ arrayfire
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-arrayfire.git
More information about the debian-science-commits
mailing list