From: Robert Jördens <jordens@gmail.com>
Date: Fri, 29 Nov 2013 06:38:24 +0000 (-0700)
Subject: doc/api, index: add fhdl.structure, add index/search
X-Git-Tag: 24jan2021_ls180~2099^2~425
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=cf0fb5350fc8ac9bff46e85db40b1e1fe1f98101;p=litex.git

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.
---

diff --git a/doc/api.rst b/doc/api.rst
index 06f23305..c9f8427b 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 6c21d762..076f8c3e 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`