Skip to content

Commit

Permalink
v2.1 doc updates (#581)
Browse files Browse the repository at this point in the history
  • Loading branch information
cathalmccabe authored and schelleg committed Feb 21, 2018
1 parent a84280c commit ad141f1
Show file tree
Hide file tree
Showing 13 changed files with 58 additions and 131 deletions.
3 changes: 2 additions & 1 deletion docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
8 changes: 3 additions & 5 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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**
Expand Down Expand Up @@ -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
Expand Down
Binary file modified docs/source/images/samba_share.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/zynq_interfaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/overlay_design_methodology/pspl_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/pynq_libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
101 changes: 0 additions & 101 deletions docs/source/pynq_libraries/pynq_microblaze.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/pynq_overlays/base_overlay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/pynq_overlays/logictools_overlay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 1 addition & 9 deletions docs/source/pynq_package/pynq.lib/pynq.lib.arduino.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------------

Expand Down
8 changes: 0 additions & 8 deletions docs/source/pynq_package/pynq.lib/pynq.lib.pmod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------

Expand Down
48 changes: 45 additions & 3 deletions docs/source/pynq_package/pynq.lib/pynq.lib.pynqmicroblaze.rst
Original file line number Diff line number Diff line change
@@ -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:

4 changes: 3 additions & 1 deletion docs/source/python_environment.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
],
Expand Down

0 comments on commit ad141f1

Please sign in to comment.