Hardware
/
f4pga-examples
mirror of https://github.com/chipsalliance/f4pga-examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/building-examples: show one example per page 

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
This commit is contained in:
Unai Martinez-Corral 2022-08-09 13:27:13 +02:00
parent c4da134437
commit ec2473b83b
8 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/building-examples.rst
View File

@ -72,23 +72,15 @@ Enter the directory that contains examples for Xilinx 7-Series FPGAs:
cd xc7 cd xc7
.. jinja:: xc7_counter_test Then, follow the guidelines for each example:
:file: templates/example.jinja
.. jinja:: xc7_picosoc_demo .. toctree::
:file: templates/example.jinja
.. jinja:: xc7_litex_demo xc7/counter_test
:file: templates/example.jinja xc7/picosoc_demo
xc7/litex_demo
.. jinja:: xc7_linux_litex_demo xc7/timer
:file: templates/example.jinja xc7/pulse_width_led
.. jinja:: xc7_timer
:file: templates/example.jinja
.. jinja:: xc7_pulse_width_led
:file: templates/example.jinja
QuickLogic EOS S3 QuickLogic EOS S3
@ -101,5 +93,8 @@ Enter the directory that contains examples for QuickLogic EOS S3:
cd eos-s3 cd eos-s3
.. jinja:: eos-s3_btn_counter Then, follow the guidelines for each example:
:file: templates/example.jinja
.. toctree::
eos-s3/btn_counter

2
docs/collect_readmes.py
View File

@ -102,7 +102,7 @@ def handle_img(block):
ret = {} ret = {}
ret['type'] = 'image' ret['type'] = 'image'
ret['uri'] = '_static/' + os.path.join(*block['uri'].split('/')[3:]) ret['uri'] = '../_static/' + os.path.join(*block['uri'].split('/')[3:])
ret['align'] = block.get('align', 'center') ret['align'] = block.get('align', 'center')
ret['width'] = block.get('width', '100%') ret['width'] = block.get('width', '100%')

2
docs/eos-s3/btn_counter.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: eos-s3_btn_counter
:file: templates/example.jinja

2
docs/xc7/counter_test.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: xc7_counter_test
:file: templates/example.jinja

2
docs/xc7/litex_demo.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: xc7_litex_demo
:file: templates/example.jinja

2
docs/xc7/picosoc_demo.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: xc7_picosoc_demo
:file: templates/example.jinja

2
docs/xc7/pulse_width_led.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: xc7_pulse_width_led
:file: templates/example.jinja

2
docs/xc7/timer.rst Normal file
View File

@ -0,0 +1,2 @@
.. jinja:: xc7_timer
:file: templates/example.jinja