Maciej Kurc
06b1ddddc1
Merge pull request #1730 from isi-rcg/tool_docs
...
Tool docs
2022-05-25 13:52:27 +02:00
Unai Martinez-Corral
5a41cf408b
docs: hierarchy
...
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-24 11:59:37 +01:00
Unai Martinez-Corral
a92d3a1d8e
docs: update theme; add logo and favicon
...
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
2022-02-23 14:35:43 +01:00
Ben Reynwar
3d5b29336f
Fixing segdata file format description in docs.
...
Signed-off-by: Ben Reynwar <breynwar@isi.edu>
2021-09-03 16:49:40 -04:00
Ben Reynwar
fdc0dea7c5
Adding description of segdata file format.
...
Signed-off-by: Ben Reynwar <breynwar@isi.edu>
2021-08-04 17:45:47 -04:00
Ben Reynwar
6a031b6474
Adding short explanations of tools (courtesy of acomodi on the symbiflow chat).
...
Signed-off-by: Ben Reynwar <breynwar@isi.edu>
2021-08-04 12:10:55 -04:00
Daniel Schultz
b85a2c12df
fixup! docs: Update "new device" section
...
Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
2021-04-01 20:38:47 +02:00
litghost
2046bcaa9a
Merge pull request #1627 from dnltz/WIP/dnltz/parts_fixups
...
Docu fixup and prevent AssertionError
2021-04-01 09:23:18 -07:00
Alessandro Comodi
0219727e9c
cells_data: add clock information on ports.json
...
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-03-26 13:47:38 +01:00
Daniel Schultz
0cd104463e
docs: Update "new device" section
...
Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
2021-03-26 08:28:54 +01:00
Alessandro Comodi
9a35b89c93
docs: add cells_data documentation
...
Signed-off-by: Alessandro Comodi <acomodi@antmicro.com>
2021-03-09 20:58:15 +01:00
Daniel Schultz
6856651990
docs: Update newpart.rst for new part handling
...
Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
2021-01-12 22:36:58 +01:00
Robert Winkler
310292cf58
docs: Force Sphinx version higher or equal to 3.0
...
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-15 10:00:59 +01:00
Robert Winkler
82309c0aa3
docs: Add recommonmark to extension list
...
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-15 10:00:59 +01:00
Robert Winkler
0ff4327729
docs: Fix links generation for markdown-code-symlinks
...
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-12-15 10:00:59 +01:00
Tim Callahan
d2de96b75f
Fix trailing space issues.
...
Signed-off-by: Tim Callahan <tcal@google.com>
2020-11-20 12:11:26 -08:00
Tim Callahan
c502aa029b
Some final edits (fix section level of "Database Updates").
...
Signed-off-by: Tim Callahan <tcal@google.com>
2020-11-20 11:37:01 -08:00
Tim Callahan
7f77e9f2af
rm NEWPART.md; update README pointer; small edits.
...
Signed-off-by: Tim Callahan <tcal@google.com>
2020-11-20 10:19:10 -08:00
Tim Callahan
94f14cec0a
Doc for adding a new part to PrjXray.
...
Signed-off-by: Tim Callahan <tcal@google.com>
2020-11-20 10:18:33 -08:00
Keith Rothman
6497a56b15
Fixup doc requirements to work around https://github.com/pypa/pip/issues/9031
...
Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
2020-10-23 15:17:14 -07:00
Ken Shirriff
3cdbb021d5
Update tile_type.rst
...
Replace typo PIN_NAME with PIP_NAME.
Also minor typo fixes.
Signed-off-by: Ken Shirriff <ken.shirriff@gmail.com>
2020-10-03 12:29:05 -07:00
Tomasz Michalak
159d6a8e88
Add licensing header to Makefiles
...
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-26 07:33:12 -07:00
Tomasz Michalak
93b77925a9
Add licensing header to rest of python scripts
...
Signed-off-by: Tomasz Michalak <tmichalak@antmicro.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-26 07:33:12 -07:00
Robert Winkler
4e13706c00
Documentation of part specific files
...
This commit adds description of part specific X-Ray database files:
- tilegrid.json
- tileconn.json
- part.yaml & part.json
- package_pins.csv
Signed-off-by: Robert Winkler <rwinkler@antmicro.com>
2020-05-19 14:14:29 +02:00
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