Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: do not inline examples as this never works with most Sphinx setups ...

This commit is contained in:
Sebastien Bourdeauducq 2013-02-10 18:45:06 +01:00
parent 3f063db281
commit 6bca9c8b98
2 changed files with 1 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/dataflow.rst
View File

@ -185,7 +185,7 @@ The ``Token`` class contains the following items:
* The name of the endpoint from which it is to be received, or to which it is to be transmitted. This value is not modified by the transaction. * The name of the endpoint from which it is to be received, or to which it is to be transmitted. This value is not modified by the transaction.
* A dictionary of values corresponding to the fields of the token. Fields that are lower-level records are represented by another dictionary. This item should be set to ``None`` (default) when receiving from a sink. * A dictionary of values corresponding to the fields of the token. Fields that are lower-level records are represented by another dictionary. This item should be set to ``None`` (default) when receiving from a sink.
See :ref:`dfsimexample` for an example demonstrating the use of these actors. See ``dataflow.py`` in the examples folder of the Migen sources for a demonstration of the use of these actors.
Arithmetic and logic actors Arithmetic and logic actors
=========================== ===========================

35
doc/simulation.rst
View File

@ -131,38 +131,3 @@ The generic top-level object
Migen comes with a ``migen.sim.generic.TopLevel`` object that implements the above behaviour. It should be usable in the majority of cases. Migen comes with a ``migen.sim.generic.TopLevel`` object that implements the above behaviour. It should be usable in the majority of cases.
The main parameters of its constructor are the output VCD file (default: ``None``) and the levels of hierarchy that must be present in the VCD (default: 1). The main parameters of its constructor are the output VCD file (default: ``None``) and the levels of hierarchy that must be present in the VCD (default: 1).
Simulation examples
*******************
Most basic
==========
.. include:: ../examples/sim/basic1.py
:code: python
A few more features
===================
.. include:: ../examples/sim/basic2.py
:code: python
Memory access
=============
.. include:: ../examples/sim/memory.py
:code: python
A FIR filter
============
.. include:: ../examples/sim/fir.py
:code: python
Abstract bus transactions
=========================
.. include:: ../examples/sim/abstract_transactions.py
:code: python
.. _dfsimexample:
Dataflow simulation actors
==========================
.. include:: ../examples/sim/dataflow.py
:code: python