Commit Graph

32 Commits

Author SHA1 Message Date
Unai Martinez-Corral 5a41cf408b docs: hierarchy
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-24 11:59:37 +01:00
Robert Winkler 1b296ea876 New structure of project documentation
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-05-19 14:14:29 +02:00
Tim Ansell 85ccaa09b4
Merge pull request #1257 from antmicro/docs_fix_warnings
Fix warnings in documentation
2020-03-18 15:19:41 -07:00
Tomasz Michalak 2f6c99d085 Extend bitstream format
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
2020-03-12 13:46:31 +01:00
Robert Winkler 675af0728c Fix warnings in documentation
This commit resolves all warnings in the project documentation

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-03-11 10:32:04 +01:00
Alessandro Comodi f1fd0c975a docs: removed src directory to have working readthedocs build
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-24 11:49:00 +02:00
Alessandro Comodi aa0fa7ba75 using markdown as package from repository
also moved all documenation sources in `src` directory

Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:51:28 +02:00
Alessandro Comodi d0ab539f25 fixing documentation cross-reference links
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:44:45 +02:00
Tim 'mithro' Ansell 85060dd1d6 Fix the INT references.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-28 19:05:53 -07:00
Tim 'mithro' Ansell 50139c524d docs: Adding warning to FIXMEs.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-28 18:43:13 -07:00
Tim 'mithro' Ansell a1c629819c docs: Fixing the :term:`PIP` References.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-28 18:43:13 -07:00
Tim 'mithro' Ansell 3b498612cb docs: Strip trailing space.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-28 18:43:13 -07:00
Tim 'mithro' Ansell c1fff54ef3 docs: Adding stuff from review.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-27 12:27:34 -05:00
Tim 'mithro' Ansell b75360584d docs: Import wiki pages.
* Interconnect page.
 * Reference page.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-27 12:08:55 -05:00
Michael Gielda 3333a14e15
docs: Fix some formatting
Signed-off-by: Michael Gielda <mgielda@antmicro.com>
2019-04-05 08:21:39 -07:00
Tim 'mithro' Ansell 31ef5df168 docs: Whitespace cleanup.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:09:24 -07:00
Tim 'mithro' Ansell cd7bcf4875 docs: Fixing headers levels.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:07:59 -07:00
Keith Rothman 8dcfe36bb9 Split single and dual port 128x1 modes.
Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
2018-10-31 15:52:03 -07:00
Keith Rothman 9aed3fef7c Add documentation for DRAM segbits.
Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
2018-10-31 15:43:10 -07:00
Sarah Maddox fc37897c35 Tweaked some glossary terms.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-05-14 14:34:46 +10:00
Sarah Maddox 62f0ca316e Added some glossary terms.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-05-14 14:18:12 +10:00
Sarah Maddox 132253fda4 Links the term 'column' to the glossary entry.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-05-07 11:11:21 +10:00
Sarah Maddox 26c36a3606 Added some glossary entries.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-22 15:30:45 +10:00
Sarah Maddox e962ca40da Modified some terms that include abbreviations and fixed alphabetical order.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-19 11:59:22 +10:00
Sarah Maddox 59082d9530 Fixes link to non-existent glossary entry.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-18 15:18:43 +10:00
Sarah Maddox 696d1c4140 Added separate lines for BLE long-form definitions.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-18 14:21:43 +10:00
Sarah Maddox cdf9ba9135 Fixed some RST errors.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-18 09:48:34 +10:00
Sarah Maddox 0cc1695f3b Merged glossary from prjxray wiki and tidied up some terms.
Signed-off-by: Sarah Maddox <sarahmaddox@google.com>
2018-04-18 09:48:10 +10:00
Rick Altherr e6a3bdc0ed docs: configuration addressing section and rough notes for others
Describes how frame addressing relates to physical chip structure. Rough
notes on how frames are loaded into the device and the packet format
used to operate that state machine.

Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
2018-02-07 14:50:52 -08:00
Rick Altherr 13a44b273d docs: Fix poor grammar
Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
2018-02-06 10:48:27 -08:00
Rick Altherr beb8e0bcf9 docs: overview of 7-Series architecture
Describes the top-level physical structure.

Signed-off-by: Rick Altherr <raltherr@google.com>
2018-02-05 17:14:27 -08:00
Rick Altherr dd5305a271 docs: Define some terms
Tried to merge definitions from wiki/Glossary and my understandings of
terms related to architecture and configuration.

Signed-off-by: Rick Altherr <raltherr@google.com>
2018-02-05 17:14:27 -08:00