Hardware
/
litex
mirror of https://github.com/enjoy-digital/litex.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix warnings during doc build

This commit is contained in:
Yann Sionneau 2015-04-22 14:31:42 +02:00 committed by Sebastien Bourdeauducq
parent e5b170f02d
commit 2f45d4640b
2 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api.rst
View File

@ -2,42 +2,42 @@ migen API Documentation
======================= =======================
:mod:`fhdl.structure` Module :mod:`fhdl.structure` Module
------------------------------ ----------------------------
.. automodule:: migen.fhdl.structure .. automodule:: migen.fhdl.structure
:members: :members:
:show-inheritance: :show-inheritance:
:mod:`fhdl.bitcontainer` Module :mod:`fhdl.bitcontainer` Module
------------------------------ -------------------------------
.. automodule:: migen.fhdl.bitcontainer .. automodule:: migen.fhdl.bitcontainer
:members: :members:
:show-inheritance: :show-inheritance:
:mod:`genlib.fifo` Module :mod:`genlib.fifo` Module
------------------------------ -------------------------
.. automodule:: migen.genlib.fifo .. automodule:: migen.genlib.fifo
:members: :members:
:show-inheritance: :show-inheritance:
:mod:`genlib.coding` Module :mod:`genlib.coding` Module
------------------------------ ---------------------------
.. automodule:: migen.genlib.coding .. automodule:: migen.genlib.coding
:members: :members:
:show-inheritance: :show-inheritance:
:mod:`genlib.cordic` Module :mod:`genlib.cordic` Module
------------------------------ ---------------------------
.. automodule:: migen.genlib.cordic .. automodule:: migen.genlib.cordic
:members: :members:
:show-inheritance: :show-inheritance:
:mod:`genlib.sort` Module :mod:`genlib.sort` Module
------------------------------ -------------------------
.. automodule:: migen.genlib.sort .. automodule:: migen.genlib.sort
:members: :members:

102
doc/fhdl.rst
View File

@ -260,57 +260,57 @@ Summary of special attributes
.. table:: Summary of special attributes .. table:: Summary of special attributes
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| Syntax | Action | | Syntax | Action |
+============================================+==============================================================+ +============================================+==============================================================+
| self.comb += stmt | Add combinatorial statement to current module. | | self.comb += stmt | Add combinatorial statement to current module. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.comb += stmtA, stmtB | Add combinatorial statements A and B to current module. | | self.comb += stmtA, stmtB | Add combinatorial statements A and B to current module. |
| | | | | |
| self.comb += [stmtA, stmtB] | | | self.comb += [stmtA, stmtB] | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.sync += stmt | Add synchronous statement to current module, in default | | self.sync += stmt | Add synchronous statement to current module, in default |
| | clock domain sys. | | | clock domain sys. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.sync.foo += stmt | Add synchronous statement to current module, in clock domain | | self.sync.foo += stmt | Add synchronous statement to current module, in clock domain |
| | foo. | | | foo. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.sync.foo += stmtA, stmtB | Add synchronous statements A and B to current module, in | | self.sync.foo += stmtA, stmtB | Add synchronous statements A and B to current module, in |
| | clock domain foo. | | | clock domain foo. |
| self.sync.foo += [stmtA, stmtB] | | | self.sync.foo += [stmtA, stmtB] | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.submodules += mod | Add anonymous submodule to current module. | | self.submodules += mod | Add anonymous submodule to current module. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.submodules += modA, modB | Add anonymous submodules A and B to current module. | | self.submodules += modA, modB | Add anonymous submodules A and B to current module. |
| | | | | |
| self.submodules += [modA, modB] | | | self.submodules += [modA, modB] | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.submodules.bar = mod | Add submodule named bar to current module. The submodule can | | self.submodules.bar = mod | Add submodule named bar to current module. The submodule can |
| | then be accessed using self.bar. | | | then be accessed using self.bar. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.specials += spe | Add anonymous special to current module. | | self.specials += spe | Add anonymous special to current module. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.specials += speA, speB | Add anonymous specials A and B to current module. | | self.specials += speA, speB | Add anonymous specials A and B to current module. |
| | | | | |
| self.specials += [speA, speB] | | | self.specials += [speA, speB] | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.specials.bar = spe | Add special named bar to current module. The special can | | self.specials.bar = spe | Add special named bar to current module. The special can |
| | then be accessed using self.bar. | | | then be accessed using self.bar. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.clock_domains += cd | Add clock domain to current module. | | self.clock_domains += cd | Add clock domain to current module. |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.clock_domains += cdA, cdB | Add clock domains A and B to current module. | | self.clock_domains += cdA, cdB | Add clock domains A and B to current module. |
| | | | | |
| self.clock_domains += [cdA, cdB] | | | self.clock_domains += [cdA, cdB] | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
| self.clock_domains.pix = ClockDomain() | Create and add clock domain pix to current module. The clock | | self.clock_domains.pix = ClockDomain() | Create and add clock domain pix to current module. The clock |
| | domain name is pix in all cases. It can be accessed using | | | domain name is pix in all cases. It can be accessed using |
| self.clock_domains._pix = ClockDomain() | self.pix, self._pix, self.cd_pix and self._cd_pix, | | self.clock_domains._pix = ClockDomain() | self.pix, self._pix, self.cd_pix and self._cd_pix, |
| | respectively. | | | respectively. |
| self.clock_domains.cd_pix = ClockDomain() | | | self.clock_domains.cd_pix = ClockDomain() | |
| | | | | |
| self.clock_domains._cd_pix = ClockDomain() | | | self.clock_domains._cd_pix = ClockDomain() | |
+--------------------------------------------+--------------------------------------------------------------+ +--------------------------------------------+--------------------------------------------------------------+
Clock domain management Clock domain management
======================= =======================