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.
2013-11-28 23:38:24 -07:00 · 2013-11-28 23:38:24 -07:00 · cf0fb5350f
parent be9fea182d
commit cf0fb5350f
2 changed files with 18 additions and 2 deletions
--- 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:
--- 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`