Added instructions to build docs with sphinx

Author: edwinsolisf

.gitignore

@@ -40,8 +40,6 @@ coverage.xml
 .pytest_cache/
 
 # documentation build artifacts
-
-docs/*.md
 docs/api
 site/
 mkdocs.yml

docs/README.md

@@ -0,0 +1,17 @@
+Documentation
+==========
+
+We use [`Sphinx`](https://www.sphinx-doc.org/en/master/index.html) for presenting our documentation.
+
+To build the docs follow these steps:
+
+1. Install the required sphinx packages and extensions from the [requirements.txt](../requirements.txt)
+```sh
+pip install -r requirements.txt # install sphinx and its extensions
+```
+2. Build docs using sphinx
+```sh
+sphinx-build -M html docs/ output-docs/ # builds docs as html files stored in output-docs
+```
+3. Explore the docs starting at `output-docs/index.html`
+

docs/afjit.py

@@ -5,20 +5,22 @@
 # removed, then the execution of this code would be equivalent to the
 # following function.
 
-def pi_no_jit(x, y, temp, samples):
+import arrayfire as af
+
+def pi_no_jit(x, y, samples):
     temp = x * x
     temp.eval()
     temp += y * y
     temp.eval()
-    temp = sqrt(temp)
+    temp = af.sqrt(temp)
     temp.eval()
     temp = temp < 1
     temp.eval()
-    return 4.0 * sum(temp) / samples
+    return 4.0 * af.sum(temp) / samples
 
-def pi_jit(x, y, temp, samples):
-    temp = sqrt(x * x + y * y) < 1
+def pi_jit(x, y, samples):
+    temp = af.sqrt(x * x + y * y) < 1
     temp.eval()
-    return 4.0 * sum(temp) / samples
+    return 4.0 * af.sum(temp) / samples
 
 # [jit-endsnippet]