riscv
/
OpenFPGA
mirror of https://github.com/lnis-uofu/OpenFPGA.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #219 from lnis-uofu/dev 

Documentation Patches on Supporting PDF builds
This commit is contained in:
tangxifan 2021-02-07 11:15:19 -07:00 committed by GitHub
parent 6cb44db9f4 05fea49b87
commit 9f7d03cd05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/requirements.txt
View File

@ -11,6 +11,9 @@ sphinxcontrib-bibtex<2.0.0
# Package required to embed youtube video # Package required to embed youtube video
sphinxcontrib-yt sphinxcontrib-yt
# Package required to convert svg for pdf builder
sphinxcontrib-svg2pdfconverter
#Work-around bug "AttributeError: 'Values' object has no attribute 'character_level_inline_markup'" with docutils 0.13.1 #Work-around bug "AttributeError: 'Values' object has no attribute 'character_level_inline_markup'" with docutils 0.13.1
#See: #See:
# * https://github.com/sphinx-doc/sphinx/issues/3951 # * https://github.com/sphinx-doc/sphinx/issues/3951

6
docs/source/conf.py
View File

@ -37,6 +37,12 @@ try:
except ImportError: except ImportError:
have_sphinxcontrib_youtube = False have_sphinxcontrib_youtube = False
# Import sphinxcontrib.svg2pdfconverter
have_sphinxcontrib_svg2pdfconverter = True
try:
import sphinxcontrib.svg2pdfconverter
except ImportError:
have_sphinxcontrib_svg2pdfconverter = False
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------

6
docs/source/overview/motivation.rst
View File

@ -1,9 +1,11 @@
Why OpenFPGA? Why OpenFPGA?
------------- -------------
.. note:: If this is the first time you learn OpenFPGA, we strongly recommend you to watch the introduction video. .. note:: If this is the first time you learn OpenFPGA, we strongly recommend you to watch the `introduction video <https://youtu.be/ocODUGcYGqo>`_
.. youtube:: ocODUGcYGqo .. only:: html
.. youtube:: ocODUGcYGqo
OpenFPGA aims to be an open-source framework that enables rapid prototyping of customizable FPGA architectures. As shown in :numref:`fig_openfpga_motivation`, a conventional approach will take a large group of experienced engineers more than one year to achieve production-ready layout and assoicated CAD tools. In fact, most of the engineering efforts are spent on manual layouts and developing ad-hoc CAD support. OpenFPGA aims to be an open-source framework that enables rapid prototyping of customizable FPGA architectures. As shown in :numref:`fig_openfpga_motivation`, a conventional approach will take a large group of experienced engineers more than one year to achieve production-ready layout and assoicated CAD tools. In fact, most of the engineering efforts are spent on manual layouts and developing ad-hoc CAD support.

6
docs/source/tutorials/compile.rst
View File

@ -3,9 +3,11 @@
How to Compile How to Compile
-------------- --------------
.. note:: We recommend you to watch a tutorial video about how-to-compile before getting started .. note:: We recommend you to watch a tutorial `video <https://youtu.be/F9sMRmDewM0>`_ about how-to-compile before getting started
.. youtube:: F9sMRmDewM0 .. only:: html
.. youtube:: F9sMRmDewM0
General Guidelines General Guidelines
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

6
docs/source/tutorials/design_flow/generate_fabric.rst
View File

@ -3,9 +3,11 @@
Generate Fabric Netlists Generate Fabric Netlists
------------------------ ------------------------
.. note:: You may watch the video representation of this tutorial .. note:: You may watch the `video <https://youtu.be/aJ0OkZ1uh68>`_ representation of this tutorial
.. youtube:: aJ0OkZ1uh68 .. only:: html
.. youtube:: aJ0OkZ1uh68
This tutorial will show an example how to This tutorial will show an example how to
- generate Verilog netlists for a FPGA fabric - generate Verilog netlists for a FPGA fabric