[Doc] Correct bugs in compiling latexpdf

This commit is contained in:
tangxifan 2021-02-07 16:17:54 -07:00
parent b556e6e7df
commit 9c5368f912
3 changed files with 9 additions and 33 deletions

View File

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

View File

@ -23,29 +23,12 @@ import sphinx_rtd_theme
#html_theme = "sphinx_rtd_theme"
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Import sphinxcontrib.bibtex
have_sphinxcontrib_bibtex = True
try:
import sphinxcontrib.bibtex
except ImportError:
have_sphinxcontrib_bibtex = False
# Import sphinxcontrib.yt
have_sphinxcontrib_youtube = True
try:
import sphinxcontrib.yt
except ImportError:
have_sphinxcontrib_youtube = False
# Import sphinxcontrib.svg2pdfconverter
have_sphinxcontrib_svg2pdfconverter = True
have_sphinx_ext_imgconverter = True
try:
import sphinxcontrib.svg2pdfconverter
import sphinx.ext.imgconverter
except ImportError:
have_sphinxcontrib_svg2pdfconverter = False
have_sphinx_ext_imgconverter = False
# For bibtex support
import sphinxcontrib.bibtex
# For embedded youtube
import sphinxcontrib.yt
# For converting SVG to PNG
import sphinx.ext.imgconverter
# -- Project information -----------------------------------------------------
@ -75,8 +58,7 @@ extensions = [
'sphinxcontrib.bibtex',
'sphinx.ext.autosectionlabel',
'sphinxcontrib.yt',
'sphinxcontrib.cairosvgconverter',
# 'sphinx.ext.imgconverter',
'sphinx.ext.imgconverter',
]
# Add any paths that contain templates here, relative to this directory.
@ -170,8 +152,6 @@ latex_elements = {
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
'preamble': '\\usepackage{tikz}',
'preamble': '\\usepackage{svg}',
}
# Grouping the document tree into LaTeX files. List of tuples

View File

@ -1160,7 +1160,7 @@ Template
.. option:: <wire_param model_type="<string>" R="<float>" C="<float>" num_level="<int>"/>
- ``model_type="pi|T"`` Specify the type of RC models for this wire segement. Currently, OpenFPGA supports the π-type and T-type multi-level RC models.
- ``model_type="pi|T"`` Specify the type of RC models for this wire segement. Currently, OpenFPGA supports the :math:`\pi`-type and T-type multi-level RC models.
- ``R="<float>"`` Specify the total resistance of the wire
- ``C="<float>"`` Specify the total capacitance of the wire.
- ``num_level="<int>"`` Specify the number of levels of the RC wire model.
@ -1193,7 +1193,7 @@ The code describing this wire is:
This example shows
- A routing track wire has 1 input and output
- The routing wire will be modelled as a 1-level π-type RC wire model with a total resistance of :math:`103.84\Omega` and a total capacitance of :math:`13.89fF`
- The routing wire will be modelled as a 1-level :math:`\pi`-type RC wire model with a total resistance of :math:`103.84\Omega` and a total capacitance of :math:`13.89fF`
I/O pads
~~~~~~~~