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

45 lines
902 B
ReStructuredText
Raw Normal View History

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-29 01:38:24 -05:00
migen API Documentation
=======================
:mod:`fhdl.structure` Module
------------------------------
.. automodule:: migen.fhdl.structure
:members:
:show-inheritance:
setup API documentation, start by documenting fifos
2013-11-28 03:46:52 -05:00
fhdl.size: rename to bitcontainer
2013-12-03 16:12:40 -05:00
:mod:`fhdl.bitcontainer` Module
migen.fhdl.size: add fiter(), fslice(), and freversed() do not overload __len__, __iter__, __reversed__ as not all valid expressions (ints and bools) have them. furthermore len([]) is and should be different from flen([]) (the later raises an error). keep __getitem__ as an exception that proves the rule ;)
2013-12-02 19:19:32 -05:00
------------------------------
fhdl.size: rename to bitcontainer
2013-12-03 16:12:40 -05:00
.. automodule:: migen.fhdl.bitcontainer
migen.fhdl.size: add fiter(), fslice(), and freversed() do not overload __len__, __iter__, __reversed__ as not all valid expressions (ints and bools) have them. furthermore len([]) is and should be different from flen([]) (the later raises an error). keep __getitem__ as an exception that proves the rule ;)
2013-12-02 19:19:32 -05:00
:members:
:show-inheritance:
setup API documentation, start by documenting fifos
2013-11-28 03:46:52 -05:00
:mod:`genlib.fifo` Module
------------------------------
.. automodule:: migen.genlib.fifo
:members:
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-29 01:38:24 -05:00
:show-inheritance:
genlib/coding: add docstrings, add it to api doc
2013-11-29 04:36:48 -05:00
:mod:`genlib.coding` Module
------------------------------
.. automodule:: migen.genlib.coding
:members:
:show-inheritance:
genlib/cordic: cleanup, documentation, unittests
2013-11-30 08:55:01 -05:00
:mod:`genlib.cordic` Module
------------------------------
.. automodule:: migen.genlib.cordic
:members:
:show-inheritance:
genlib/sort: add bitonic, combinatorial sorter complete with with api documentation and unittests
2013-11-29 21:52:42 -05:00
:mod:`genlib.sort` Module
------------------------------
.. automodule:: migen.genlib.sort
:members:
:show-inheritance: