diff --git a/.readthedocs.yml b/.readthedocs.yml index 049c8b2c9..5ff1814f4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,6 +5,10 @@ # Required configuration file version version: 2 +# Specify docker image for building the doc +build: + image: latest + # Build documentation in the docs/ directory with Sphinx sphinx: builder: dirhtml @@ -16,5 +20,6 @@ formats: all # Optionally set the version of Python and requirements required to build your docs python: version: 3.7 + system_packages: true install: - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt index c66cd1334..cd8e75de7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -11,7 +11,7 @@ sphinxcontrib-bibtex<2.0.0 # Package required to embed youtube video sphinxcontrib-yt -# Package required to convert svg for pdf builder +# Package required to convert SVG for latex building sphinxcontrib-svg2pdfconverter #Work-around bug "AttributeError: 'Values' object has no attribute 'character_level_inline_markup'" with docutils 0.13.1 diff --git a/docs/source/conf.py b/docs/source/conf.py index 55f4c8a26..0f442d9bd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,26 +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 -try: - import sphinxcontrib.svg2pdfconverter -except ImportError: - have_sphinxcontrib_svg2pdfconverter = False +# For bibtex support +import sphinxcontrib.bibtex +# For embedded youtube +import sphinxcontrib.yt +# For converting SVG to PNG using rsvg +import sphinxcontrib.rsvgconverter # -- Project information ----------------------------------------------------- @@ -72,6 +58,7 @@ extensions = [ 'sphinxcontrib.bibtex', 'sphinx.ext.autosectionlabel', 'sphinxcontrib.yt', + 'sphinxcontrib.rsvgconverter', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/manual/arch_lang/circuit_model_examples.rst b/docs/source/manual/arch_lang/circuit_model_examples.rst index 1f4c0c1d3..263ee1724 100644 --- a/docs/source/manual/arch_lang/circuit_model_examples.rst +++ b/docs/source/manual/arch_lang/circuit_model_examples.rst @@ -1160,7 +1160,7 @@ Template .. option:: - - ``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=""`` Specify the total resistance of the wire - ``C=""`` Specify the total capacitance of the wire. - ``num_level=""`` 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 ~~~~~~~~