From cf0fb5350fc8ac9bff46e85db40b1e1fe1f98101 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20J=C3=B6rdens?= Date: Thu, 28 Nov 2013 23:38:24 -0700 Subject: [PATCH] doc/api, index: add fhdl.structure, add index/search genindex is needed to generate links between members and search is useful for the html docs. --- doc/api.rst | 12 ++++++++++-- doc/index.rst | 8 ++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 06f233054..c9f8427b3 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -1,8 +1,16 @@ -migen Package -============= +migen API Documentation +======================= + +:mod:`fhdl.structure` Module +------------------------------ + +.. automodule:: migen.fhdl.structure + :members: + :show-inheritance: :mod:`genlib.fifo` Module ------------------------------ .. automodule:: migen.genlib.fifo :members: + :show-inheritance: diff --git a/doc/index.rst b/doc/index.rst index 6c21d762f..076f8c3e5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,3 +11,11 @@ Migen manual simulation casestudies api + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + +.. * :ref:`modindex`