From 6bca9c8b984fb1357e01aa3bb7dd3357c22a9732 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Sun, 10 Feb 2013 18:45:06 +0100 Subject: [PATCH] doc: do not inline examples as this never works with most Sphinx setups ... --- doc/dataflow.rst | 2 +- doc/simulation.rst | 35 ----------------------------------- 2 files changed, 1 insertion(+), 36 deletions(-) diff --git a/doc/dataflow.rst b/doc/dataflow.rst index 6cf02edd..8026c107 100644 --- a/doc/dataflow.rst +++ b/doc/dataflow.rst @@ -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. * 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 =========================== diff --git a/doc/simulation.rst b/doc/simulation.rst index ce0a6d91..9b11e810 100644 --- a/doc/simulation.rst +++ b/doc/simulation.rst @@ -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. 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 -- 2.30.2