[skip-ci] add docs

.readthedocs.yaml

@@ -0,0 +1,11 @@
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py

README.rst

@@ -105,8 +105,8 @@ Now we can use the class directly with the SystemVerilog binding:
     assert(a.min() == 1);
 
 
-To use an array as a function argument, use `DataType.IntArray`.
-As the name indicates, pysv currently only support `int32_t` arrays of any
+To use an array as a function argument, use ``DataType.IntArray``.
+As the name indicates, pysv currently only support ``int32_t`` arrays of any
 dimension. More data types supports will be worked on in the future.
 Here is an example of how to use it in Python:
 

docs/basics.rst

@@ -112,6 +112,13 @@ Whereas in C/C++ we will see the following function definition:
 Notice that your function can take normal input arguments. All the output arguments will be
 generated after the inputs.
 
+
+If we want to pass a SystemVerilog open array to Python and used in libraries such as numpy,
+you can use ``DataType.IntArray``. Currently only ``int32_t`` type is supported. Because it
+uses ``py::memoryview`` under the hood, the array will not be coppied. Instead, it is
+accessed via a multable array view. As a result, the system can handle arbitrary number of
+dimensions.
+
 Library compilation
 -------------------
 In order to use pysv in your testbench, you first need to compile the python