Commit Graph

80 Commits

Author SHA1 Message Date
Robert Winkler 368fba8316 Apply review comments to database description
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-05-19 14:14:29 +02:00
Tomasz Michalak e851ca7bc7 Apply review comments to new fuzzer chapter
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
2020-05-19 14:14:29 +02:00
Tomasz Michalak 028aa6173c Add dsp fuzzer creation description
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
2020-05-19 14:14:29 +02:00
Tomasz Michalak 39813be4cb Add small fixes to the database documentation
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
2020-05-19 14:14:29 +02:00
Robert Winkler e8ff146443 Add description of architecture-specific database files to docs
This commit adds description of the following database files:
  - mask_*.db
  - ppips_*.db
  - segbits_*.db
  - site_type_*.db
  - tile_type_*.db

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-05-19 14:14:29 +02: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
Robert Winkler c30f755423 Change theme to Sphinx Material Design
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2019-09-26 22:27:49 +02:00
Alessandro Comodi 2fab112c71 docs: fixed some READMEs and removed empty .md file generation
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-25 09:54:28 +02: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 5254a5f82b docs: move conf.py in upper directory
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-23 18:20:43 +02:00
Alessandro Comodi bd92376224 updated requirements
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 16:28:28 +02:00
Alessandro Comodi 399721258d run make format
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 16:12:15 +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 68eb426527 addressed review comments
Added prefix for code urls
Changed Domain class name

Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:44:45 +02:00
Alessandro Comodi 78ffa253ff removing unnecessary print
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:44:45 +02:00
Alessandro Comodi 78fd7843a5 run make format
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2019-09-04 15:44:45 +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
Michael Gielda d652967229 Add SF theme to requirements
Signed-off-by: Michael Gielda <mgielda@antmicro.com>
2019-08-27 15:13:47 +02:00
Michael Gielda aa0a90c138 Change theme to SymbiFlow
Signed-off-by: Michael Gielda <mgielda@antmicro.com>
2019-08-26 09:57:30 +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
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