Commit Graph

96 Commits

Author SHA1 Message Date
Yehowshua Immanuel 3da204edd6 update to work with mac 2020-02-15 10:37:39 -05:00
Sean Cross a2f1683b97 doc: rename lxsocdoc -> socdoc and update readme
With the merge of lxsocdoc into upstream litex, the old name of
"lxsocdoc" doesn't make as much sense.  Additionally, the import paths
are now different.

Rename this file to reflect the new home of `soc/doc`, and update the
code examples to work with the new name.

Signed-off-by: Sean Cross <sean@xobs.io>
2020-02-13 08:47:58 +08:00
Sean Cross ae085782ae doc: add lxsocdoc.md (README from lxsocdoc repository) 2020-02-05 11:06:57 +01:00
Florent Kermarrec 79665873df doc: add litex-hub logo 2019-06-09 19:36:09 +02:00
Florent Kermarrec 442d7358ce doc: redesign new logo 2019-06-09 00:36:46 +02:00
Florent Kermarrec 591186279a doc: add new logo 2019-06-08 00:45:30 +02:00
Florent Kermarrec 2c3c6bdf9b Updating documents from LiteX BuildEnv Wiki 2019-04-28 11:41:33 +02:00
Tim 'mithro' Ansell 65650919a7 Updating documents from LiteX BuildEnv Wiki 2019-04-26 17:44:36 -05:00
Tim 'mithro' Ansell a43de8195f Updating documents from LiteX BuildEnv Wiki 2019-04-26 17:44:36 -05:00
Tim 'mithro' Ansell e42de8fe52 docs: Adding script to pull useful docs from LiteX BuildEnv's wiki. 2019-04-26 14:28:20 -05:00
Florent Kermarrec 1158b98fdd doc: update logo 2015-11-13 23:40:27 +01:00
Florent Kermarrec d0ec57add6 doc: add logo 2015-11-11 13:36:29 +01:00
Florent Kermarrec 6a0f85dc42 litex: reorganize things, first work working version 2015-11-07 17:48:55 +01:00
Sebastien Bourdeauducq b8647a161d doc: minor edits 2015-09-21 21:19:39 +08:00
Sebastien Bourdeauducq 2ac748aef2 doc: remove spurious file 2015-09-20 16:13:08 +08:00
Sebastien Bourdeauducq 74b0cfc83b doc: remove outdated or moved parts, cleanup 2015-09-20 16:10:40 +08:00
Sebastien Bourdeauducq 0b9c6720d8 doc: Constant 2015-09-17 11:05:57 +08:00
Sebastien Bourdeauducq 336728413a simplify imports, migen.fhdl.std -> migen 2015-09-12 19:34:07 +08:00
Sebastien Bourdeauducq 86f34e82c3 mibuild -> migen.build 2015-09-10 10:53:15 -07:00
psmears d435f30fa3 Minor improvements to wording 2015-06-18 12:26:22 +01:00
Sebastien Bourdeauducq 01e2343978 doc: remove cordic 2015-05-01 14:07:38 +08:00
Yann Sionneau 2f45d4640b doc: fix warnings during doc build 2015-04-23 12:34:17 +08:00
Tim 'mithro' Ansell e2af9ac9a6 Expanding the install instructions a little.
This is based on the discussion at https://github.com/m-labs/misoc/issues/6
2015-04-14 23:03:45 +08:00
Florent Kermarrec 17e5249be0 global: pep8 (replace tabs with spaces) 2015-04-13 20:07:07 +02:00
Florent Kermarrec 452c60e0c3 endpoints: add param_layout parameter (required to pass parameter data with converters and will allow logic optimizations) 2015-02-14 03:10:56 -08:00
Robert Jordens 11fedfc825 doc: update for NetworkX refactoring 2014-09-07 16:48:46 +08:00
Sebastien Bourdeauducq a36a208dd1 sim: use (mandatory) ncycles when starting a simulation with no active functions 2014-04-13 15:16:27 +02:00
Sebastien Bourdeauducq d26330a9b9 Update doc with new simulation API 2014-02-07 23:08:59 +01:00
Robert Jordens 8d3d61ba98 fhdl.size: rename to bitcontainer 2013-12-03 22:51:52 +01:00
Robert Jordens fe67210d77 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-03 21:36:33 +01:00
Robert Jordens dd24fdd356 genlib/sort: add bitonic, combinatorial sorter
complete with with api documentation and unittests
2013-12-02 12:56:36 +01:00
Robert Jordens 9762546c95 genlib/cordic: cleanup, documentation, unittests 2013-12-02 12:56:24 +01:00
Robert Jordens 9b0f43e631 doc/index.rst: drop index and table chapter, index and search are also generated without 2013-11-29 23:47:48 +01:00
Robert Jördens 5b26fb10a9 genlib/coding: add docstrings, add it to api doc 2013-11-29 23:25:31 +01:00
Robert Jördens cf0fb5350f 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 22:40:37 +01:00
Robert Jördens a836cbb44e doc/conf.py: no modindex, no numpydoc warnings
* do not generate boring modindex for html and latex outputs
* numpydoc_show_class_members=False, to skip undocumented methods
  https://github.com/phn/pytpm/issues/3#issuecomment-12133978
2013-11-29 22:31:59 +01:00
Robert Jordens 6e9e0a60eb setup API documentation, start by documenting fifos 2013-11-28 22:14:20 +01:00
Robert Jordens 89eb5ee315 add autodoc, numpydoc and doctest to sphinx to generate API doc 2013-11-28 22:14:16 +01:00
Sebastien Bourdeauducq dad389eef7 rename milkymist-ng to MiSoC 2013-11-09 18:51:16 +01:00
Sebastien Bourdeauducq b96eb339af fhdl: compact Instance syntax 2013-07-25 20:34:19 +02:00
Sebastien Bourdeauducq b7ed19c6c5 fhdl: do not export Fragment 2013-07-25 18:52:54 +02:00
Sebastien Bourdeauducq 3a3bc2e876 doc/dataflow: update to new API 2013-07-22 20:54:32 +02:00
Sebastien Bourdeauducq cf22aae06f doc: ASMI -> LASMI 2013-07-22 18:28:57 +02:00
Sebastien Bourdeauducq 794c4e6041 doc/fhdl: document Module API 2013-07-22 16:48:05 +02:00
Sebastien Bourdeauducq aef78b2395 doc/bus/CSR: add automatic CSR name info 2013-07-22 16:47:49 +02:00
Sebastien Bourdeauducq 0cef98373f doc/bus: update 2013-07-20 17:01:58 +02:00
Sebastien Bourdeauducq 38664d6e16 fhdl: inline synthesis directive support 2013-02-22 19:10:02 +01:00
Sebastien Bourdeauducq 587f50cf90 doc: new 'specials' API 2013-02-22 18:12:42 +01:00
Sebastien Bourdeauducq e82ea19cdc doc: tristates 2013-02-19 17:52:57 +01:00
Sebastien Bourdeauducq 7ff61d8930 doc: fix signal desc layout 2013-02-10 19:39:18 +01:00