From e50227e02ffcb544b48af2a3c17f0aebc8280331 Mon Sep 17 00:00:00 2001 From: Iulia Moldovan Date: Thu, 17 Aug 2023 16:19:55 +0300 Subject: [PATCH] docs: Add color roles. Fix :part: link. Remove extension * Remove sphinxcontrib.mermaid extension * Added red and green role * Fixed the :part: role link because analog.com doesn't know to redirect to proper part webpage if it's under /products Signed-off-by: Iulia Moldovan --- docs/conf.py | 1 - docs/extensions/adi_links.py | 2 +- docs/index.rst | 3 +++ docs/requirements.txt | 1 - docs/sources/custom.css | 6 ++++++ 5 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 532b4068d..f3b05cdf8 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,6 @@ sys.path.append(os.path.abspath("./extensions")) extensions = [ "sphinx.ext.todo", "sphinx.ext.viewcode", - "sphinxcontrib.mermaid", "sphinxcontrib.wavedrom", "symbolator_sphinx", "adi_links", diff --git a/docs/extensions/adi_links.py b/docs/extensions/adi_links.py index 40a11ae51..82e873da3 100644 --- a/docs/extensions/adi_links.py +++ b/docs/extensions/adi_links.py @@ -11,7 +11,7 @@ dft_url_datasheet = 'https://www.analog.com/media/en/technical-documentation/dat dft_url_dokuwiki = 'https://wiki.analog.com' dft_url_ez = 'https://ez.analog.com' dft_url_git = 'https://github.com/analogdevicesinc' -dft_url_part = 'https://www.analog.com/products' +dft_url_part = 'https://www.analog.com' dft_url_xilinx = 'https://www.xilinx.com' dft_url_intel = 'https://www.intel.com' diff --git a/docs/index.rst b/docs/index.rst index 31126fb53..b57af327f 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,9 @@ HDL Reference Designs library/spi_engine/index library/axi_dmac/index +.. role:: red +.. role:: green + .. attention:: Work-in-progress, not all content available at the diff --git a/docs/requirements.txt b/docs/requirements.txt index e2d1d18b1..f55c82892 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,7 +3,6 @@ lxml furo wavedrom sphinxcontrib-wavedrom -sphinxcontrib-mermaid sphinxcontrib-svg2pdfconverter https://github.com/hdl/pyhdlparser/tarball/master https://github.com/hdl/symbolator/tarball/master diff --git a/docs/sources/custom.css b/docs/sources/custom.css index 74c28ce31..f71ab1124 100755 --- a/docs/sources/custom.css +++ b/docs/sources/custom.css @@ -67,6 +67,12 @@ td.description { width: 45%; font-size:.8em; } +.red { + color: red; +} +.green { + color: green; +} #signal-and-interface-pins h3 { font-weight: normal; }