Commit Graph

490 Commits

Author SHA1 Message Date
tangxifan 0fee741008 [Doc] Update documentation on the minor changes on fabric bitstream file format 2021-06-07 14:22:35 -06:00
tangxifan c30be6e95e [Doc] Update documentation about the fast configuration for write bitstream command 2021-06-04 20:00:28 -06:00
tangxifan 059e74b4ef [Doc] Add --fast configuration option to documentation for 'write_full_testbench' 2021-06-04 15:17:00 -06:00
tangxifan b83d8826fb [Doc] Update documentation on the testbench organization/waveforms 2021-06-03 16:54:13 -06:00
tangxifan 9bcaa820ae [Doc] Update documentation for the new command 'write_full_testbench' 2021-06-03 16:18:07 -06:00
tangxifan 16ae23f33e [Doc] Update notes about compilation guidelines 2021-05-24 16:26:59 -06:00
tangxifan 9b40e74e25 [Doc] Add example circuit models for multipliers and update technical highlight with links to the examples 2021-05-24 15:24:50 -06:00
tangxifan 21a18069a1 [Doc] Add example circuit about dual-port RAMs to documentation; Updated technical highlights by providing links to the examples 2021-05-24 14:50:55 -06:00
tangxifan b6b98a75b8 [Doc] Add example circuit model about multi-mode flip-flops; Separate data-path FF circuit model and configuration-chain FF circuit model; 2021-05-24 13:03:40 -06:00
tangxifan 24f83f0058 [Doc] Update documentation about the new command 'report_bitstream_distribution' 2021-05-07 11:54:33 -06:00
tangxifan 1bae59dc6a [Doc] Update documentation for the write_io_mapping command 2021-04-27 14:54:57 -06:00
ganeshgore d7426808ba
Merge pull request #299 from hitblunders/master
Updated compile.rst
2021-04-26 00:26:07 -06:00
tangxifan 62dc5a3856 [Doc] Update documentation about the new syntax introduced for pin binding between operating modes and physical modes 2021-04-24 16:02:24 -06:00
Parnabrita Mondal cc92c27fde
Update compile.rst 2021-04-24 14:01:52 +05:30
tangxifan 2e1cc5499d [Doc] Add disclaimer for limitations when using repack pin constraints 2021-04-21 14:14:54 -06:00
tangxifan 9b3dcc65bd [Doc] Add new bitstream setting syntex 'interconnect' to documentation 2021-04-19 16:37:21 -06:00
bbleaptrot 986ea492f6
Fix grammar line 38: lookup table ->Look-Up Table 2021-04-19 14:16:40 -06:00
bbleaptrot bc6e9746c2
Fix more grammar mistakes 2021-04-19 09:48:42 -06:00
bbleaptrot 8431337f39
Fix grammar errors in fig captions and elsewhere 2021-04-19 09:36:13 -06:00
bbleaptrot 86c856d35a
Fix reference links 2021-04-19 09:25:54 -06:00
bbleaptrot cd6beb5789
Add one more link to fabric_netlists 2021-04-19 09:14:47 -06:00
bbleaptrot f8810940c3
Update links 2021-04-19 09:10:17 -06:00
bbleaptrot fcb7ee3283
Update to properly reference fabric netlist page 2021-04-19 09:05:30 -06:00
bbleaptrot 5010fb1e7f
Update hyperlinks 2021-04-19 08:52:05 -06:00
bbleaptrot 291638ee0f
Trying to resolve hyperlink to right location 2021-04-19 08:45:02 -06:00
bbleaptrot beed1ce31e
replace hyperlink with more stable :ref: link 2021-04-19 08:38:09 -06:00
bbleaptrot 410c6a12ff
Update figures to be more accurate and clean 2021-04-16 11:46:12 -06:00
bbleaptrot 221822f0f0
update figures to correctly display out ports 2021-04-16 11:33:01 -06:00
bbleaptrot 423d814730
Update to include new figures 2021-04-13 16:04:20 -06:00
bbleaptrot eff784e77b
Upload new figures for spypad tutorial 2021-04-13 15:53:51 -06:00
bbleaptrot 46f60d0704
Provide more explanation in Pre-Built Spypads 2021-04-12 18:10:36 -06:00
bbleaptrot 0606479bf8
Edit figures to better fit page 2021-04-12 17:53:31 -06:00
bbleaptrot bb5cd1de47
Update to fix :numref: error example figure 2021-04-12 17:09:16 -06:00
bbleaptrot a0b01dccc7
Update spypads_tutorial.rst to address comments
Add links to github OpenFPGA architecture files, reference fig_gpout_ports, instead of emphasize lines switch to numbering the important lines
2021-04-12 17:02:56 -06:00
bbleaptrot 64e8e623a5
Update to fix links to proper syntax 2021-04-12 16:14:00 -06:00
bbleaptrot bad49cdb75
Update to change Spypads to spypads 2021-04-12 16:07:38 -06:00
bbleaptrot 1744ce594e
Rename Spypads_tutorial.rst to spypads_tutorial.rst 2021-04-12 16:06:44 -06:00
bbleaptrot 90df365259
Fix a spacing issue on line 250 2021-04-12 14:21:53 -06:00
bbleaptrot 198882da89
Update link to From Verilog to Verification 2021-04-12 14:20:40 -06:00
bbleaptrot b176ca6c0c
Update to improve readability 2021-04-12 14:13:41 -06:00
bbleaptrot a2c2b634e6
Update link for _user_defined_template.v
This ensures it goes to the correct page after pull request 274 no longer works
2021-04-12 14:00:54 -06:00
bbleaptrot f626b17d04
Update user_defined_temp_tutorial
Change "example" in the beginning of the page to "tutorial" for clarity
2021-04-12 13:58:19 -06:00
tangxifan 9b7001bc0f
Merge branch 'master' into tutorials 2021-04-10 17:16:09 -06:00
tangxifan e5b47b7d3d [Doc] Update documentation on the changes on fabric bitstream file formats 2021-04-10 15:45:39 -06:00
bbleaptrot 62da6b467d
Update tutorial to correctly display code 2021-04-09 16:15:44 -06:00
bbleaptrot 47dd6f8018
Update to include spypads tutorial 2021-04-09 16:04:37 -06:00
bbleaptrot ce2e9c177b
Add figures for spypads tutorial 2021-04-09 16:03:41 -06:00
bbleaptrot 456a553884
Add Spypads tutorial 2021-04-09 16:02:37 -06:00
bbleaptrot c6ae2a9b17
Fix opening paragraph 2021-04-09 09:15:25 -06:00
bbleaptrot 1d97cbf9b2
Update to improve readability 2021-04-09 08:38:20 -06:00
bbleaptrot 1534a3a7c7
Update Figure Citations 2021-04-02 16:02:41 -06:00
bbleaptrot b4945a3c1e
Update to change information errors 2021-04-02 15:56:56 -06:00
bbleaptrot d5ec17867d
Add files via upload 2021-04-02 14:49:58 -06:00
bbleaptrot 0655cda94d
Rescale PNG images downward 2021-04-02 14:45:47 -06:00
bbleaptrot dc725dfd6f
Update to use cropped GTKWave PNGs 2021-04-02 14:43:37 -06:00
bbleaptrot 15fcf03e31
Crop GTKWaveforms 2021-04-02 14:42:23 -06:00
bbleaptrot 75891f800d
Update to fix reference link and shrink PNGs 2021-04-02 14:24:51 -06:00
bbleaptrot 71b96b9169
Update tutorial to swap in PNGs and fix errors 2021-04-02 14:22:03 -06:00
bbleaptrot 269776bb9c
Add Waveforms from GTKWave
Upload a variety of different formats for the waveforms to find which one looks the best for the Cell Libraries tutorial page
2021-04-02 14:09:23 -06:00
bbleaptrot dc991a912e
Update to fix grammar and spelling errors 2021-04-02 10:59:18 -06:00
bbleaptrot b6feecc4c3
Update to fix SVG files to show data better 2021-04-02 10:47:36 -06:00
bbleaptrot 3c27027f76
Add files via upload 2021-04-02 10:46:51 -06:00
bbleaptrot cfa2d7042d
Update Custom_Waveforms.svg 2021-04-02 10:44:36 -06:00
bbleaptrot 4c35df0df3
Update open_cell_libraries_tutorial.rst 2021-04-02 10:42:15 -06:00
bbleaptrot baee023ba2
Update Control_Waveforms3.svg 2021-04-02 10:41:47 -06:00
bbleaptrot 65d2f82b94
Update Control_Waveforms3.svg 2021-04-02 10:41:29 -06:00
bbleaptrot 9849946fab
Update Control_Waveforms3.svg 2021-04-02 10:41:12 -06:00
bbleaptrot 821847f295
Update Control_Waveforms3.svg 2021-04-02 10:40:51 -06:00
bbleaptrot 96275f9c0e
Modify Control_Waveforms to fix height and width
The height and width will now be set to the size of the viewbox
2021-04-02 10:39:20 -06:00
bbleaptrot 69b7c8f37a
Update to include new control_waveforms file 2021-04-02 10:32:31 -06:00
bbleaptrot f03754561c
Add control_waveforms with smaller viewbox 2021-04-02 10:27:49 -06:00
bbleaptrot c0256cdd87
Adjust height and width to see if image changes 2021-04-02 10:22:09 -06:00
bbleaptrot d56ba1c5d7
Modify custom waveform to have a smaller viewbox 2021-04-02 10:13:51 -06:00
bbleaptrot 1bbf878498
Modify image to have a smaller viewbox 2021-04-02 10:13:13 -06:00
bbleaptrot 6393d11153
Update to highlight correct section of code 2021-04-02 10:04:53 -06:00
bbleaptrot bff9e7aecd
Update hyperlinks to display properly 2021-04-02 10:02:26 -06:00
bbleaptrot 5f01e5e7a7
Update file 2021-04-02 09:54:54 -06:00
tangxifan 0072f4e51e
Merge branch 'master' into tutorials 2021-03-31 10:31:55 -06:00
bbleaptrot c1036c6ac4
Match spelling to file name for cell_libraries 2021-03-31 10:04:51 -06:00
bbleaptrot f8da09a80e
Update to include cell_library tutorial 2021-03-31 10:04:00 -06:00
bbleaptrot 36a6870cc0
Update tutorial to display waveforms 2021-03-30 21:59:18 -06:00
bbleaptrot f963be4cae
Add files via upload 2021-03-30 21:56:43 -06:00
bbleaptrot b8b024048e
Add first draft for Open Cell Libraries tutorial 2021-03-30 21:54:46 -06:00
tangxifan eec52360ee
Merge branch 'master' into doc_patch 2021-03-23 21:33:05 -06:00
bbleaptrot 8ee86d78dd
Implement some of the final changes 2021-03-23 20:50:54 -06:00
bbleaptrot 16cefdba28
Fix minor changes in page 2021-03-23 18:19:14 -06:00
bbleaptrot 3dea033981
Implement more code blocks for cleaner page 2021-03-23 18:12:27 -06:00
bbleaptrot ccfcae88d7
Update to remove clunky image with code-block 2021-03-23 17:41:55 -06:00
bbleaptrot 191ce358c7
Indent code-blocks 2021-03-23 17:29:34 -06:00
bbleaptrot 34a1df858b
Fix code-block syntax for XML 2021-03-23 17:25:32 -06:00
bbleaptrot 59ecaae23b
Update to use code-block syntax 2021-03-23 17:21:44 -06:00
bbleaptrot 07f05cc942
Update user_defined_temp_tutorial.rst
Update to remove two images that were hard to read on the webpage and replace with code blocks
2021-03-23 17:16:27 -06:00
bbleaptrot 4317f7add7
Update file to display images w/caps 2021-03-23 16:50:52 -06:00
bbleaptrot b194e9c395
Update index.rst
Include link to user_defined_temp_tutorial file
2021-03-23 16:37:44 -06:00
bbleaptrot 4d0e06c332
Update user_defined_temp_tutorial
Add more sections, robust instructions, and a link to documentation
2021-03-23 16:34:32 -06:00
bbleaptrot a6dfba4500
Update to try and display tutorial images 2021-03-19 16:29:25 -06:00
bbleaptrot e90bcdc4d5
Update to correctly include figure syntax 2021-03-19 16:21:45 -06:00
bbleaptrot 05ec5186a2
Update to see if .. image:: works for images 2021-03-19 16:18:21 -06:00
bbleaptrot 4e363660e7
Update to correct syntax for images 2021-03-19 16:14:51 -06:00
bbleaptrot eea73ca2bf
Add user_defined_templates.rst file 2021-03-19 16:10:46 -06:00
bbleaptrot 7b23231909
Add images for user_defined_templates.v tutorial 2021-03-19 16:08:50 -06:00
tangxifan 19b2641839
Merge branch 'master' into doc_patch 2021-03-15 11:45:32 -06:00
tangxifan fb7d76545e [Doc] Patch the schematic of LUT circuit models to be consistent with netlists 2021-03-15 11:40:09 -06:00
tangxifan ff0faeb285 [Doc] Update documentation about the extended bitstream setting 2021-03-10 21:41:59 -07:00
tangxifan c638e5bde5 [Doc] Update documentation for default net type option 2021-02-28 12:00:55 -07:00
tangxifan 01b9bf2a02 [Doc] Update num_region XML for config protocol 2021-02-18 21:58:30 -07:00
tangxifan 2eaec13351 [Doc] Reorganize tutorial documentation by grouping compilation guidelines, shell setup and tool guide into a section 2021-02-11 14:09:20 -07:00
tangxifan 702bd3bbd5
Merge pull request #231 from lnis-uofu/dev
Extended LUT Support: Now accept external LUT netlists with embedded custom logic
2021-02-11 13:57:17 -07:00
tangxifan 184788880c
Merge pull request #224 from lnis-uofu/gg_docs
[Docs] Added documentation for docker based run and shell shortcuts documentation
2021-02-11 09:26:29 -07:00
tangxifan 1c4dc9f74b [Doc] Update documentation about the super LUT feature 2021-02-10 11:49:59 -07:00
Ganesh Gore c35cf72489 [Docs] Added OpenFPGA shortcut commands docs 2021-02-07 23:53:05 -07:00
Ganesh Gore cbd2064f59 [Docs] Updated docker based run documentation 2021-02-07 23:33:25 -07:00
tangxifan 9020577e80
Support SVG in Sphinx Latex building (#220)
* [Doc] Try use image converter instead of svg2pdf which requires more dependencies

* [Doc] Add img converter to conf.py

* [Doc] Bug fix in importing imgconverter package

* [Doc] Try to fix the bug when importing python packages

* [Doc] bug fix

* [Doc] Try to use imgconverter rather than cairo

* [Doc] Add svg to latex config in sphinx configuration file

* [Doc] Try cairo svg converter

* [Doc] Correct bugs in compiling latexpdf

* [Doc] Use latest image in building readthedocs

* [Doc] Now use readthedocs docker image in building online documentation

* [Doc] Correct typo in readthedocs setting

* [Doc] Try to use inkscape converter as imgconverter converted SVG to black images

* [Doc] Try RSVG
2021-02-07 18:53:16 -07:00
tangxifan b71966363b [Doc] Try RSVG 2021-02-07 18:16:33 -07:00
tangxifan 3c1a538f7a [Doc] Try to use inkscape converter as imgconverter converted SVG to black images 2021-02-07 17:53:58 -07:00
tangxifan 9c5368f912 [Doc] Correct bugs in compiling latexpdf 2021-02-07 16:17:54 -07:00
tangxifan b556e6e7df [Doc] Try cairo svg converter 2021-02-07 14:55:13 -07:00
tangxifan 40e9960618 [Doc] Add svg to latex config in sphinx configuration file 2021-02-07 12:40:14 -07:00
tangxifan 6492d8f3a8 [Doc] Try to use imgconverter rather than cairo 2021-02-07 12:27:45 -07:00
tangxifan 4551f13290 [Doc] bug fix 2021-02-07 12:06:23 -07:00
tangxifan 8f43ab6ca4 [Doc] Try to fix the bug when importing python packages 2021-02-07 12:00:48 -07:00
tangxifan d96ffdc00c [Doc] Bug fix in importing imgconverter package 2021-02-07 11:52:04 -07:00
tangxifan 49fc903bfb [Doc] Add img converter to conf.py 2021-02-07 11:44:41 -07:00
tangxifan 6b6f4bc763 [Doc] Try use image converter instead of svg2pdf which requires more dependencies 2021-02-07 11:40:18 -07:00
tangxifan 05fea49b87 [Doc] Skip youtube video when building pdf; Apply SVG2PDF converter so that svg images can be included in the pdf 2021-02-07 10:35:20 -07:00
tangxifan f6ec558bc2 [Doc] Now embed video in the documentation 2021-02-06 19:45:41 -07:00
tangxifan a4b9199737 [Doc] Add tutorial about fabric netlist generation 2021-02-06 17:46:56 -07:00
tangxifan 1ff597ea66 [Doc] Add tutorial video links to documentation 2021-02-06 17:16:15 -07:00
AurelienAlacchi 00fc3d7622
Merge pull request #217 from lnis-uofu/dev
Synchronize the out-of-date XML syntax 'disable_in_pack' with VPR upstream
2021-02-05 09:53:28 -07:00
tangxifan c4fe9a67f7
Merge pull request #215 from lnis-uofu/compilation_fixes
Changed readthedocs.io dependencies link
2021-02-05 09:42:15 -07:00
tangxifan 9b5c64f35f [Doc] Update documentation about disable_packing syntax 2021-02-04 16:41:24 -07:00
Andrew Pond fe806f8ac3 changed docs dependencies link 2021-02-04 10:58:59 -08:00
tangxifan d83158654c [Doc] Add a draft documentation about the bitstream setting 2021-02-01 22:33:17 -07:00
tangxifan 0e16638dc2 [Doc] Update documentation about the changes on activity files 2021-01-29 11:49:07 -07:00
tangxifan 78ad9cd000 [Doc] Add version command/option to documentation 2021-01-27 16:06:45 -07:00
Ganesh Gore 0a29529731 [Docs] Added CI/CD docs 2021-01-26 16:26:43 -07:00
tangxifan d53d3963d4 [Doc] Broken link fix in config protocol documentation 2021-01-26 14:05:11 -07:00
tangxifan 97f8bccce3 [Doc] Add openfpga floorplanning to the overview part of documentation 2021-01-26 14:00:51 -07:00
tangxifan 4d5b63a685 [Doc] Fine-tune format on FPGA-SDC motivation 2021-01-26 11:04:31 -07:00
tangxifan 22a01cdb05 [Doc] Fine-tuned figure about openfpga tools to provide a clear borderline between openfpga shell and other tools/files 2021-01-26 10:36:34 -07:00
tangxifan 9fefe1502f [Doc] Typo fix on write_fabric_key option 2021-01-25 15:18:16 -07:00
tangxifan dd0680246a [Doc] Typo fix on fabric key command 2021-01-25 14:12:40 -07:00
ganeshgore 1ba7e0663f
Merge pull request #176 from lnis-uofu/dev
Documentation Formatting
2021-01-24 21:11:49 -07:00
tangxifan e18c533657 [Doc] Add new openfpga shell command to documentation 2021-01-24 14:48:56 -07:00
tangxifan 815468ac65 [Doc] Add shortcut to call pin constraint option to documentation 2021-01-20 09:20:51 -07:00
tangxifan 977ff52cb1 [Doc] Format openfpga command documentation by using option views 2021-01-19 20:26:38 -07:00
tangxifan e9dc708d66 [Doc] Group file format documentation into a unified section 2021-01-19 19:44:44 -07:00
tangxifan ac8c63553a [Doc] Add file format index file 2021-01-19 18:07:53 -07:00
tangxifan fbb5c0cf8f [Doc] Add pin constraints to documentation 2021-01-19 18:04:45 -07:00
tangxifan c7f02601ab [Doc] Add repack design constraints to documentation 2021-01-17 12:59:46 -07:00