Commit Graph

103 Commits

Author SHA1 Message Date
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
Tim 'mithro' Ansell 31d81ad314 docs: Importing wiki/Database-Files.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-27 12:08:55 -05:00
Michael Gielda b2b79007a6
docs: Rename wrong make target
Signed-off-by: Michael Gielda <mgielda@antmicro.com>
2019-04-16 03:49:19 +02: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 df7b9b48a8 docs: Create the fuzzers + minitests directories.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 19:51:43 -07:00
Tim 'mithro' Ansell 9863296a53 docs: Allow make to be run in other directories.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 19:06:31 -07:00
Tim 'mithro' Ansell 431641d038 docs: Print working directory on readthedocs.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 19:06:27 -07:00
Tim 'mithro' Ansell 9872943486 docs: Adding missing _static directory.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 11:26:53 -07:00
Tim 'mithro' Ansell 51f62b8f0b docs: Go back to 2 levels.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 11:26:23 -07:00
Tim 'mithro' Ansell eedeee16cb docs: Import README add give fuzzers structures.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 11:19:36 -07:00
Tim 'mithro' Ansell ac97aa6f5c docs: JSON highlighter doesn't exist, use Javascript instead.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:24:05 -07:00
Tim 'mithro' Ansell 0c0068697a docs: Fix header levels for format section.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:17:44 -07:00
Tim 'mithro' Ansell 326860d634 docs: Add database file format doc to TOC.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:12:27 -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 487b28c43b docs: Fix arch-defs header.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-04 10:08:39 -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
Tim 'mithro' Ansell 8c90ae2e39 docs: Adding DRAM info to TOC.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 19:28:44 -07:00
Tim 'mithro' Ansell 1df4f35835 docs: Run `make format`
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 19:09:57 -07:00
Tim 'mithro' Ansell c5751032c6 docs: Get tags on readthedocs.
Makes `git describe` work so we get the correct version information.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 19:07:55 -07:00
Tim 'mithro' Ansell e6ab6ee820 docs: Run `make links` on readthedocs.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 19:07:55 -07:00
Tim 'mithro' Ansell 853b0119da docs: Automatically link fuzzer/minitest README.md files.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 19:07:52 -07:00
Tim 'mithro' Ansell bab4c6af06 docs: Fix the markdown tables.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2019-04-03 17:46:10 -07:00
John McMaster 2bb5677d44 parsedb: merge in dbcheck
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-12-10 14:56:06 -08:00
John McMaster 341f845784 db.rst: add -m/-M doc
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-11-28 13:28:22 -08:00
John McMaster 2974492449 .db: add basic doc
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-11-14 17:15:55 -08: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
John McMaster 1205b5bddb docs: tileconn, tilegrid
Signed-off-by: John McMaster <johndmcmaster@gmail.com>
2018-08-28 17:07:09 -07:00
Rick Altherr a6f1e92ee6 docs: Remove Kaitai Struct bitstream description
Kaitai Struct only support purely stateless parsing. That only works up
to the packet layer for Xilinx bitstreams. As there are now both C++
(prjxray) and Rust (gaffe) parsers that work up through config frames,
the KSY only serves to mislead someone that Kaitai Struct works for this
purpose.

Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
2018-06-06 12:18:55 -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
Tim 'mithro' Ansell ca42a39317 docs: Fixing lint errors.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-02-28 18:40:56 -08:00
Tim 'mithro' Ansell 03f901d010 docs: Fixing the GitHub URL in conf.py
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-02-28 13:12:33 -08:00
Tim 'mithro' Ansell 8be0223f30 docs: Adding info about minitest.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-02-28 13:12:33 -08:00
Tim 'mithro' Ansell 9b31f55788 docs: Max depth of 1.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-02-28 13:12:33 -08:00
Tim 'mithro' Ansell a5f2a85fff docs: Adding the current fuzzers + minitests into documentation.
* Using the same approach [as in my VTRs pull request](https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/297)

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2018-02-28 13:12:33 -08:00
Davide ad4580d8ed Changed folder name for the 'database development process' of the docs and updated the index.rst page accordingly.
Also a few minor changes as requested by @mithro regarding the content itself and rearranged the paragraphs.

Signed-off-by: Davide <davide.toldo@stud.tu-darmstadt.de>
2018-02-19 22:10:09 +01:00
Davide f2fb1fd145 added database development process to FAQ
Signed-off-by: Davide <davide.toldo@stud.tu-darmstadt.de>
2018-02-19 17:21:46 +01: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 0970edb384 docs: Make target for live reloading during editing
Target starts sphinx-autobuild which watches the source files and
rebuilds the output on writes. Output is served via a local HTTP server
that injects code to refresh the page when a new version is available.
Saving a source file triggers the browser to reload the page generated.

Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
2018-02-07 14:36:54 -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
Rick Altherr 1fc306b147 docs: Initial setup for Sphinx-based documentation
Signed-off-by: Rick Altherr <raltherr@google.com>
2018-02-05 17:14:27 -08:00
Tim 'mithro' Ansell c237bcd412 Adding top level docs.
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 23:28:27 +01:00
Rick Altherr fa162e0b54 Kaitai Struct KSY for Xilinx Bitstream format
When loaded into https://ide.kaitai.io, Xilinx bitstreams can be
visually explored a lot more easily.

Signed-off-by: Rick Altherr <kc8apf@kc8apf.net>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
2017-12-20 22:46:39 +01:00