update API docs

* including to Python 3 version (function instead of method)
kecnry · Oct 1, 2020 · 9870415 · 9870415
1 parent 226ec9f
commit 9870415
Show file tree

Hide file tree

Showing 102 changed files with 327 additions and 138 deletions.
diff --git a/docs/api/Arange.__init__.md b/docs/api/Arange.__init__.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).__init__ (method)
+### [Arange](Arange.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Arange.copy.md b/docs/api/Arange.copy.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).copy (method)
+### [Arange](Arange.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Arange.md b/docs/api/Arange.md
@@ -1,9 +1,15 @@
 ## Arange (class)
 
+
+This is available as a top-level convenience function as [nparray.arange](nparray.arange.md).
+
+
+
 * [__init__](Arange.__init__.md)
 * [array](Arange.array.md)
 * [copy](Arange.copy.md)
 * [quantity](Arange.quantity.md)
+* [shape](Arange.shape.md)
 * [to](Arange.to.md)
 * [to_array](Arange.to_array.md)
 * [to_dict](Arange.to_dict.md)

diff --git a/docs/api/Arange.shape.md b/docs/api/Arange.shape.md
@@ -0,0 +1,4 @@
+### [Arange](Arange.md).shape (property)
+
+
+
diff --git a/docs/api/Arange.to.md b/docs/api/Arange.to.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to (method)
+### [Arange](Arange.md).to (function)
 
 
 ```py

diff --git a/docs/api/Arange.to_array.md b/docs/api/Arange.to_array.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to_array (method)
+### [Arange](Arange.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Arange.to_dict.md b/docs/api/Arange.to_dict.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to_dict (method)
+### [Arange](Arange.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Arange.to_file.md b/docs/api/Arange.to_file.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to_file (method)
+### [Arange](Arange.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Arange.to_json.md b/docs/api/Arange.to_json.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to_json (method)
+### [Arange](Arange.md).to_json (function)
 
 
 ```py

diff --git a/docs/api/Arange.to_linspace.md b/docs/api/Arange.to_linspace.md
@@ -1,4 +1,4 @@
-### [Arange](Arange.md).to_linspace (method)
+### [Arange](Arange.md).to_linspace (function)
 
 
 ```py

diff --git a/docs/api/Array.__init__.md b/docs/api/Array.__init__.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).__init__ (method)
+### [Array](Array.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Array.copy.md b/docs/api/Array.copy.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).copy (method)
+### [Array](Array.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Array.md b/docs/api/Array.md
@@ -1,9 +1,15 @@
 ## Array (class)
 
+
+This is available as a top-level convenience function as [nparray.array](nparray.array.md).
+
+
+
 * [__init__](Array.__init__.md)
 * [array](Array.array.md)
 * [copy](Array.copy.md)
 * [quantity](Array.quantity.md)
+* [shape](Array.shape.md)
 * [to](Array.to.md)
 * [to_array](Array.to_array.md)
 * [to_dict](Array.to_dict.md)

diff --git a/docs/api/Array.shape.md b/docs/api/Array.shape.md
@@ -0,0 +1,4 @@
+### [Array](Array.md).shape (property)
+
+
+
diff --git a/docs/api/Array.to.md b/docs/api/Array.to.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).to (method)
+### [Array](Array.md).to (function)
 
 
 ```py

diff --git a/docs/api/Array.to_array.md b/docs/api/Array.to_array.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).to_array (method)
+### [Array](Array.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Array.to_dict.md b/docs/api/Array.to_dict.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).to_dict (method)
+### [Array](Array.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Array.to_file.md b/docs/api/Array.to_file.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).to_file (method)
+### [Array](Array.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Array.to_json.md b/docs/api/Array.to_json.md
@@ -1,4 +1,4 @@
-### [Array](Array.md).to_json (method)
+### [Array](Array.md).to_json (function)
 
 
 ```py

diff --git a/docs/api/Eye.__init__.md b/docs/api/Eye.__init__.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).__init__ (method)
+### [Eye](Eye.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Eye.copy.md b/docs/api/Eye.copy.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).copy (method)
+### [Eye](Eye.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Eye.md b/docs/api/Eye.md
@@ -1,9 +1,15 @@
 ## Eye (class)
 
+
+This is available as a top-level convenience function as [nparray.eye](nparray.eye.md).
+
+
+
 * [__init__](Eye.__init__.md)
 * [array](Eye.array.md)
 * [copy](Eye.copy.md)
 * [quantity](Eye.quantity.md)
+* [shape](Eye.shape.md)
 * [to](Eye.to.md)
 * [to_array](Eye.to_array.md)
 * [to_dict](Eye.to_dict.md)

diff --git a/docs/api/Eye.shape.md b/docs/api/Eye.shape.md
@@ -0,0 +1,4 @@
+### [Eye](Eye.md).shape (property)
+
+
+
diff --git a/docs/api/Eye.to.md b/docs/api/Eye.to.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).to (method)
+### [Eye](Eye.md).to (function)
 
 
 ```py

diff --git a/docs/api/Eye.to_array.md b/docs/api/Eye.to_array.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).to_array (method)
+### [Eye](Eye.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Eye.to_dict.md b/docs/api/Eye.to_dict.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).to_dict (method)
+### [Eye](Eye.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Eye.to_file.md b/docs/api/Eye.to_file.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).to_file (method)
+### [Eye](Eye.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Eye.to_json.md b/docs/api/Eye.to_json.md
@@ -1,4 +1,4 @@
-### [Eye](Eye.md).to_json (method)
+### [Eye](Eye.md).to_json (function)
 
 
 ```py

diff --git a/docs/api/Full.__init__.md b/docs/api/Full.__init__.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).__init__ (method)
+### [Full](Full.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Full.copy.md b/docs/api/Full.copy.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).copy (method)
+### [Full](Full.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Full.md b/docs/api/Full.md
@@ -1,9 +1,16 @@
 ## Full (class)
 
+
+This is available as a top-level convenience function as [nparray.full](nparray.full.md) or
+[nparray.full_like](nparray.full_like.md).
+
+
+
 * [__init__](Full.__init__.md)
 * [array](Full.array.md)
 * [copy](Full.copy.md)
 * [quantity](Full.quantity.md)
+* [shape](Full.shape.md)
 * [to](Full.to.md)
 * [to_array](Full.to_array.md)
 * [to_dict](Full.to_dict.md)

diff --git a/docs/api/Full.shape.md b/docs/api/Full.shape.md
@@ -0,0 +1,4 @@
+### [Full](Full.md).shape (property)
+
+
+
diff --git a/docs/api/Full.to.md b/docs/api/Full.to.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to (method)
+### [Full](Full.md).to (function)
 
 
 ```py

diff --git a/docs/api/Full.to_array.md b/docs/api/Full.to_array.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to_array (method)
+### [Full](Full.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Full.to_dict.md b/docs/api/Full.to_dict.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to_dict (method)
+### [Full](Full.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Full.to_file.md b/docs/api/Full.to_file.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to_file (method)
+### [Full](Full.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Full.to_json.md b/docs/api/Full.to_json.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to_json (method)
+### [Full](Full.md).to_json (function)
 
 
 ```py

diff --git a/docs/api/Full.to_linspace.md b/docs/api/Full.to_linspace.md
@@ -1,4 +1,4 @@
-### [Full](Full.md).to_linspace (method)
+### [Full](Full.md).to_linspace (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.__init__.md b/docs/api/Geomspace.__init__.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).__init__ (method)
+### [Geomspace](Geomspace.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.copy.md b/docs/api/Geomspace.copy.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).copy (method)
+### [Geomspace](Geomspace.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.md b/docs/api/Geomspace.md
@@ -1,9 +1,15 @@
 ## Geomspace (class)
 
+
+This is available as a top-level convenience function as [nparray.geomspace](nparray.geomspace.md).
+
+
+
 * [__init__](Geomspace.__init__.md)
 * [array](Geomspace.array.md)
 * [copy](Geomspace.copy.md)
 * [quantity](Geomspace.quantity.md)
+* [shape](Geomspace.shape.md)
 * [to](Geomspace.to.md)
 * [to_array](Geomspace.to_array.md)
 * [to_dict](Geomspace.to_dict.md)

diff --git a/docs/api/Geomspace.shape.md b/docs/api/Geomspace.shape.md
@@ -0,0 +1,4 @@
+### [Geomspace](Geomspace.md).shape (property)
+
+
+
diff --git a/docs/api/Geomspace.to.md b/docs/api/Geomspace.to.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).to (method)
+### [Geomspace](Geomspace.md).to (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.to_array.md b/docs/api/Geomspace.to_array.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).to_array (method)
+### [Geomspace](Geomspace.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.to_dict.md b/docs/api/Geomspace.to_dict.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).to_dict (method)
+### [Geomspace](Geomspace.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.to_file.md b/docs/api/Geomspace.to_file.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).to_file (method)
+### [Geomspace](Geomspace.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Geomspace.to_json.md b/docs/api/Geomspace.to_json.md
@@ -1,4 +1,4 @@
-### [Geomspace](Geomspace.md).to_json (method)
+### [Geomspace](Geomspace.md).to_json (function)
 
 
 ```py

diff --git a/docs/api/Linspace.__init__.md b/docs/api/Linspace.__init__.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).__init__ (method)
+### [Linspace](Linspace.md).__init__ (function)
 
 
 ```py

diff --git a/docs/api/Linspace.copy.md b/docs/api/Linspace.copy.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).copy (method)
+### [Linspace](Linspace.md).copy (function)
 
 
 ```py

diff --git a/docs/api/Linspace.md b/docs/api/Linspace.md
@@ -1,9 +1,15 @@
 ## Linspace (class)
 
+
+This is available as a top-level convenience function as [nparray.linspace](nparray.linspace.md).
+
+
+
 * [__init__](Linspace.__init__.md)
 * [array](Linspace.array.md)
 * [copy](Linspace.copy.md)
 * [quantity](Linspace.quantity.md)
+* [shape](Linspace.shape.md)
 * [to](Linspace.to.md)
 * [to_arange](Linspace.to_arange.md)
 * [to_array](Linspace.to_array.md)

diff --git a/docs/api/Linspace.shape.md b/docs/api/Linspace.shape.md
@@ -0,0 +1,4 @@
+### [Linspace](Linspace.md).shape (property)
+
+
+
diff --git a/docs/api/Linspace.to.md b/docs/api/Linspace.to.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to (method)
+### [Linspace](Linspace.md).to (function)
 
 
 ```py

diff --git a/docs/api/Linspace.to_arange.md b/docs/api/Linspace.to_arange.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to_arange (method)
+### [Linspace](Linspace.md).to_arange (function)
 
 
 ```py

diff --git a/docs/api/Linspace.to_array.md b/docs/api/Linspace.to_array.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to_array (method)
+### [Linspace](Linspace.md).to_array (function)
 
 
 ```py

diff --git a/docs/api/Linspace.to_dict.md b/docs/api/Linspace.to_dict.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to_dict (method)
+### [Linspace](Linspace.md).to_dict (function)
 
 
 ```py

diff --git a/docs/api/Linspace.to_file.md b/docs/api/Linspace.to_file.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to_file (method)
+### [Linspace](Linspace.md).to_file (function)
 
 
 ```py

diff --git a/docs/api/Linspace.to_json.md b/docs/api/Linspace.to_json.md
@@ -1,4 +1,4 @@
-### [Linspace](Linspace.md).to_json (method)
+### [Linspace](Linspace.md).to_json (function)
 
 
 ```py