v2.1 doc updates (#581)

Xilinx · Feb 21, 2018 · ad141f1 · ad141f1
1 parent a84280c
commit ad141f1
Show file tree

Hide file tree

Showing 13 changed files with 58 additions and 131 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -7,7 +7,7 @@ Version 2.1
 
 Image release: pynq_z1_v2.1
 
-Documentation updated 14 Feb 2018
+Documentation updated 21 Feb 2018
 
 * Overlay Changes
    * All overlays updated to build with Vivado 2017.4
@@ -26,6 +26,7 @@ Documentation updated 14 Feb 2018
    * Updated to Ubuntu 16.04 LTS (Xenial)
    * Updated kernel to tagged 2017.4 Xilinx release.
    * Jupyter now listens on both :80 and :9090 ports
+   * opencv2.4.9 removed
 * Microblaze Programming
    * IPython magics added for Jupyter programming of Microblazes
    * Microblaze pyprintf, RPC, and Python-callable function generation added.

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -42,8 +42,8 @@ Micro SD card preloaded with the PYNQ-Z1 image, you can skip this step.
 
 To make your own PYNQ Micro-SD card:
 
-  1. `Download the PYNQ-Z1 image
-     <https://files.digilent.com/Products/PYNQ/pynq_z1_v2.0.img.zip>`_
+  1. `Download the PYNQ-Z1 v2.1 image (released 21 Feb 2018)
+     <http://files.digilent.com/Products/PYNQ/pynq_z1_v2.1.img.zip>`_
   2. Unzip the image 
   3. Write the image to a blank Micro SD card (minimum 8GB recommended)
 
@@ -59,7 +59,7 @@ Board Setup
       :align: center
 
   1. Set the **JP4 / Boot** jumper to the *SD* position by
-     placing the jumper over the bottom two pins of JP4 as shown in the image.
+     placing the jumper over the top two pins of JP4 as shown in the image.
      (This sets the board to boot from the Micro-SD card)
 
   2. To power the PYNQ-Z1 from the micro USB cable, set the **JP5 / Power**
@@ -225,8 +225,6 @@ When prompted, the username is **xilinx** and the password is **xilinx**. The
 following screen should appear:
 
 .. image:: images/samba_share.JPG
-    :height: 600px
-    :scale: 75%
     :align: center
 
 To access the home area in Ubuntu, open a file broswer, click Go -> Enter

diff --git a/docs/source/images/samba_share.JPG b/docs/source/images/samba_share.JPG
diff --git a/docs/source/images/zynq_interfaces.png b/docs/source/images/zynq_interfaces.png
diff --git a/docs/source/overlay_design_methodology/pspl_interface.rst b/docs/source/overlay_design_methodology/pspl_interface.rst
@@ -10,6 +10,7 @@ ports, 2x AXI Slave GP ports and 1x AXI Master ACP port. There are also GPIO
 controllers in the PS that are connected to the PL.
 
 .. image:: ../images/zynq_interfaces.png
+   :height: 500px
    :align: center
 
 There are four ``pynq`` classes that are used to manage data movement between 

diff --git a/docs/source/pynq_libraries.rst b/docs/source/pynq_libraries.rst
@@ -61,6 +61,6 @@ driver provided, before the peripheral can be used.
     pynq_libraries/arduino.rst
     pynq_libraries/grove.rst
     pynq_libraries/logictools.rst
-    pynq_libraries/pynq_microblaze.rst
+    pynq_libraries/pynq_microblaze_subsystem.rst
     pynq_libraries/pynqmb_python.rst
     pynq_libraries/pynqmb_reference.rst       
diff --git a/docs/source/pynq_libraries/pynq_microblaze.rst b/docs/source/pynq_libraries/pynq_microblaze.rst
diff --git a/docs/source/pynq_overlays/base_overlay.rst b/docs/source/pynq_overlays/base_overlay.rst
@@ -206,7 +206,7 @@ Assuming PYNQ has been cloned:
    source ./build_base_ip.tcl
    source ./base.tcl
 
-To build from the command line, open the Vivado 2016.1 Tcl Shell, and run the 
+To build from the command line, open the Vivado 2017.4 Tcl Shell, and run the 
 following:
 
 .. code-block:: console

diff --git a/docs/source/pynq_overlays/logictools_overlay.rst b/docs/source/pynq_overlays/logictools_overlay.rst
@@ -121,7 +121,7 @@ Assuming PYNQ has been cloned:
    source ./build_logictools_ip.tcl
    source ./logictools.tcl
 
-To build from the command line, open the Vivado 2016.1 Tcl Shell, and run the 
+To build from the command line, open the Vivado 2017.4 Tcl Shell, and run the 
 following:
 
 .. code-block:: console

diff --git a/docs/source/pynq_package/pynq.lib/pynq.lib.arduino.rst b/docs/source/pynq_package/pynq.lib/pynq.lib.arduino.rst
@@ -30,15 +30,7 @@ pynq.lib.arduino.arduino_grove_buzzer Module
     :members:
     :undoc-members:
     :show-inheritance:
-
-pynq.lib.arduino.arduino_grove_color Module
--------------------------------------------
-
-.. automodule:: pynq.lib.arduino.arduino_grove_color
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+
 pynq.lib.arduino.arduino_grove_ear_hr Module
 --------------------------------------------
 

diff --git a/docs/source/pynq_package/pynq.lib/pynq.lib.pmod.rst b/docs/source/pynq_package/pynq.lib/pynq.lib.pmod.rst
@@ -127,14 +127,6 @@ pynq.lib.pmod.pmod_grove_buzzer Module
     :undoc-members:
     :show-inheritance:
 
-pynq.lib.pmod.pmod_grove_color Module
--------------------------------------
-
-.. automodule:: pynq.lib.pmod.pmod_grove_color
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 pynq.lib.pmod.pmod_grove_dlight Module
 --------------------------------------
 

diff --git a/docs/source/pynq_package/pynq.lib/pynq.lib.pynqmicroblaze.rst b/docs/source/pynq_package/pynq.lib/pynq.lib.pynqmicroblaze.rst
@@ -1,9 +1,51 @@
 .. _pynq-lib-pynqmicroblaze:
 
-pynq.lib.pynqmicroblaze Module
-==============================
+pynq.lib.pynqmicroblaze.pynqmicroblaze Module
+=============================================
 
-.. automodule:: pynq.lib.pynqmicroblaze
+.. automodule:: pynq.lib.pynqmicroblaze.pynqmicroblaze
     :members:
     :undoc-members:
     :show-inheritance:
+
+pynq.lib.pynqmicroblaze.compile Module
+======================================
+
+.. automodule:: pynq.lib.pynqmicroblaze.compile
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pynq.lib.pynqmicroblaze.rpc Module
+==================================
+
+.. automodule:: pynq.lib.pynqmicroblaze.rpc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pynq.lib.pynqmicroblaze.magic Module
+====================================
+
+.. automodule:: pynq.lib.pynqmicroblaze.magic
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+pynq.lib.pynqmicroblaze.streams Module
+======================================
+
+.. automodule:: pynq.lib.pynqmicroblaze.streams
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pynq.lib.pynqmicroblaze.bsp Module
+==================================
+
+.. automodule:: pynq.lib.pynqmicroblaze.bsp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/python_environment.ipynb b/docs/source/python_environment.ipynb
@@ -259,7 +259,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "[3, 13, 23, 43, 53, 73, 83, 103, 113, 163, 173, 193, 223, 233, 263, 283, 293, 313, 353, 373, 383, 433, 443, 463, 503, 523, 563, 593, 613, 643, 653, 673, 683, 733, 743, 773, 823, 853, 863, 883, 953, 983, 1013, 1033, 1063]\n"
+      "[3, 13, 23, 43, 53, 73, 83, 103, 113, 163, 173, 193, 223, 233, 263, 283, 293, 313,\n",
+	  "353, 373, 383, 433, 443, 463, 503, 523, 563, 593, 613, 643, 653, 673, 683, 733, 743,\n",
+	  "773, 823, 853, 863, 883, 953, 983, 1013, 1033, 1063]\n"
      ]
     }
    ],