Skip to content

Commit b6152e0

Browse files
committed
docs: use flex badges for status badges, img for logo
Raw html doesn't work for other builder format. Since the logo image are written by a custom extension at the builder-inited step, prefix the image uri with ?:// to safely trick the builder into considering it as a remote uri, to not try to copy over and raise a warning. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
1 parent 8cce91e commit b6152e0

File tree

3 files changed

+46
-49
lines changed

3 files changed

+46
-49
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
<img src="https://app.codacy.com/project/badge/Grade/200b7479f5024f6ea386350ca1049077" alt="Codacy Badge">
1818
</a>
1919

20-
<a href="https://www.python.org/download/releases/3.8.0/">
21-
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python Version">
20+
<a href="https://www.python.org/downloads/">
21+
<img src="https://www.python.org/downloads/" alt="Python Version">
2222
</a>
2323
</p>
2424

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"ext_pyadi_iio",
5151
]
5252

53-
needs_extensions = {"adi_doctools": "0.3.36"}
53+
needs_extensions = {"adi_doctools": "0.4.21"}
5454

5555
# Add any paths that contain templates here, relative to this directory.
5656
templates_path = ["_templates"]

doc/source/index.rst

Lines changed: 43 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -17,52 +17,49 @@ Analog Devices Hardware Python Interfaces
1717
# Get data from transceiver
1818
data = sdr.rx()
1919
20-
.. raw:: html
21-
22-
<center>
23-
<div style="width:70%;">
24-
<div id="indexlogo" class="only-light">
25-
<img src="_static/logos/PyADI-IIO_Logo_600.png" alt="PyADI-IIO Logo" />
26-
</div>
27-
<div id="indexlogo" class="only-dark">
28-
<img src="_static/logos/PyADI-IIO_Logo_w_600.png" alt="PyADI-IIO Logo" />
29-
</div>
30-
</div>
31-
</center>
32-
33-
.. raw:: html
34-
35-
<div align="center" id="badges">
36-
<a href="https://github.com/analogdevicesinc/pyadi-iio/actions">
37-
<img src="https://github.com/analogdevicesinc/pyadi-iio/actions/workflows/test.yml/badge.svg" alt="Build Status">
38-
</a>
39-
40-
<a href="https://badge.fury.io/py/pyadi-iio">
41-
<img src="https://badge.fury.io/py/pyadi-iio.svg" alt="PyPI version">
42-
</a>
43-
44-
<a href="https://www.codacy.com/gh/analogdevicesinc/pyadi-iio/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=analogdevicesinc/pyadi-iio&amp;utm_campaign=Badge_Grade">
45-
<img src="https://app.codacy.com/project/badge/Grade/200b7479f5024f6ea386350ca1049077" alt="Codacy Badge">
46-
</a>
47-
48-
<a href="https://www.python.org/download/releases/3.6.0/">
49-
<img src="https://img.shields.io/badge/python-3.6+-blue.svg" alt="Python Version">
50-
</a>
51-
</div>
52-
53-
<div align="center" id="badges">
54-
<a href="http://analogdevicesinc.github.io/pyadi-iio/">
55-
<img alt="GitHub Pages" src="https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg">
56-
</a>
57-
58-
<a href="https://ez.analog.com/sw-interface-tools/f/q-a">
59-
<img alt="EngineerZone" src="https://img.shields.io/badge/Support-on%20EngineerZone-blue.svg">
60-
</a>
61-
62-
<a href="https://wiki.analog.com/resources/tools-software/linux-software/pyadi-iio">
63-
<img alt="Analog Wiki" src="https://img.shields.io/badge/Wiki-on%20wiki.analog.com-blue.svg">
64-
</a>
65-
</div>
20+
.. image:: _static/logos/PyADI-IIO_Logo_w_600.png?://
21+
:class: only-dark
22+
:width: 700px
23+
:alt: PyADI-IIO Logo
24+
25+
.. image:: _static/logos/PyADI-IIO_Logo_600.png?://
26+
:class: only-light
27+
:width: 700px
28+
:alt: PyADI-IIO Logo
29+
30+
.. flex::
31+
:class: badges
32+
33+
.. image:: https://github.com/analogdevicesinc/pyadi-iio/actions/workflows/test.yml/badge.svg
34+
:target: https://github.com/analogdevicesinc/pyadi-iio/actions
35+
:alt: Build Status
36+
37+
.. image:: https://badge.fury.io/py/pyadi-iio.svg
38+
:target: https://badge.fury.io/py/pyadi-iio
39+
:alt: PyPI version
40+
41+
.. image:: https://app.codacy.com/project/badge/Grade/200b7479f5024f6ea386350ca1049077
42+
:target: https://www.codacy.com/gh/analogdevicesinc/pyadi-iio/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=analogdevicesinc/pyadi-iio&amp;utm_campaign=Badge_Grade
43+
:alt: Codacy Badge
44+
45+
.. image:: https://img.shields.io/pypi/pyversions/pyadi-iio
46+
:target: https://www.python.org/downloads/
47+
:alt: Python Version
48+
49+
.. flex::
50+
:class: badges
51+
52+
.. image:: https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg
53+
:target: http://analogdevicesinc.github.io/pyadi-iio/
54+
:alt: GitHub Pages
55+
56+
.. image:: https://img.shields.io/badge/Support-on%20EngineerZone-blue.svg
57+
:target: https://ez.analog.com/sw-interface-tools/f/q-a
58+
:alt: EngineerZone Support
59+
60+
.. image:: https://img.shields.io/badge/Wiki-on%20wiki.analog.com-blue.svg
61+
:target: https://wiki.analog.com/resources/tools-software/linux-software/pyadi-iio
62+
:alt: Analog Wiki
6663

6764

6865
Requirements

0 commit comments

Comments
 (0)