zcy
/
pluto_hdl_adi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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 <Iulia.Moldovan@analog.com>
main
Iulia Moldovan 2023-08-17 16:19:55 +03:00 committed by imoldovan
parent daf9e1744a
commit e50227e02f
5 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/conf.py
View File

@ -19,7 +19,6 @@ sys.path.append(os.path.abspath("./extensions"))
extensions = [ extensions = [
"sphinx.ext.todo", "sphinx.ext.todo",
"sphinx.ext.viewcode", "sphinx.ext.viewcode",
"sphinxcontrib.mermaid",
"sphinxcontrib.wavedrom", "sphinxcontrib.wavedrom",
"symbolator_sphinx", "symbolator_sphinx",
"adi_links", "adi_links",

2
docs/extensions/adi_links.py
View File

@ -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_dokuwiki = 'https://wiki.analog.com'
dft_url_ez = 'https://ez.analog.com' dft_url_ez = 'https://ez.analog.com'
dft_url_git = 'https://github.com/analogdevicesinc' 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_xilinx = 'https://www.xilinx.com'
dft_url_intel = 'https://www.intel.com' dft_url_intel = 'https://www.intel.com'

3
docs/index.rst
View File

@ -16,6 +16,9 @@ HDL Reference Designs
library/spi_engine/index library/spi_engine/index
library/axi_dmac/index library/axi_dmac/index
.. role:: red
.. role:: green
.. attention:: .. attention::
Work-in-progress, not all content available at the Work-in-progress, not all content available at the

1
docs/requirements.txt
View File

@ -3,7 +3,6 @@ lxml
furo furo
wavedrom wavedrom
sphinxcontrib-wavedrom sphinxcontrib-wavedrom
sphinxcontrib-mermaid
sphinxcontrib-svg2pdfconverter sphinxcontrib-svg2pdfconverter
https://github.com/hdl/pyhdlparser/tarball/master https://github.com/hdl/pyhdlparser/tarball/master
https://github.com/hdl/symbolator/tarball/master https://github.com/hdl/symbolator/tarball/master

6
docs/sources/custom.css
View File

@ -67,6 +67,12 @@ td.description {
width: 45%; width: 45%;
font-size:.8em; font-size:.8em;
} }
.red {
color: red;
}
.green {
color: green;
}
#signal-and-interface-pins h3 { #signal-and-interface-pins h3 {
font-weight: normal; font-weight: normal;
} }