doc/api, index: add fhdl.structure, add index/search
authorRobert Jördens <jordens@gmail.com>
Fri, 29 Nov 2013 06:38:24 +0000 (23:38 -0700)
committerSebastien Bourdeauducq <sebastien@milkymist.org>
Fri, 29 Nov 2013 21:40:37 +0000 (22:40 +0100)
genindex is needed to generate links between members and search is
useful for the html docs.

doc/api.rst
doc/index.rst

index 06f23305444b6a2e651e51ba355f31080859c981..c9f8427b305f34bb87d92e0afebc6f987048c22a 100644 (file)
@@ -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:
index 6c21d762f20cd1561260ab108b3a53a7fa1fffd6..076f8c3e5a28ae067a7374b6119f6ecb200d7485 100644 (file)
@@ -11,3 +11,11 @@ Migen manual
    simulation
    casestudies
    api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
+.. * :ref:`modindex`