Skip to content

docs: use flex badges for status badges, img for logo#683

Merged
tfcollins merged 1 commit intomainfrom
staging/docs-badges
Sep 15, 2025
Merged

docs: use flex badges for status badges, img for logo#683
tfcollins merged 1 commit intomainfrom
staging/docs-badges

Conversation

@gastmaier
Copy link
Contributor

@gastmaier gastmaier commented Sep 9, 2025

Description

Raw html doesn't work for other builder formats.
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.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Hardware:
  • OS:

Documentation

If this is a new feature or example please mention or link any documentation. All new hardware interface classes require documentation.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have signed off all commits and they contain "Signed-off by: "
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@github-actions
Copy link

github-actions bot commented Sep 9, 2025

Test Results

1 712 tests  ±0     461 ✅ ±0   11m 57s ⏱️ ±0s
    1 suites ±0   1 251 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit 9b7b1c7. ± Comparison against base commit 8cce91e.

This pull request removes 4 and adds 4 tests. Note that renamed tests count towards both.
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=rx_hardwaregain_chan0-val=[25.0, 26.0, 8.5, 32.5, 23.0, 34.0, 3.5, 19.0, 25.5, 16.0]-depends={'gain_control_mode_chan1': 'spi', 'rx_ensm_mode_chan1': 'rf_enabled'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=rx_hardwaregain_chan0-val=[27.0, 6.0, 23.0, 22.5, 15.0, 20.5, 30.5, 8.5, 3.0, 10.0]-depends={'gain_control_mode_chan0': 'spi', 'rx_ensm_mode_chan0': 'rf_enabled'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=tx_hardwaregain_chan0-val=[-19.8, -37.35, -2.5, -1.95, -3.15, -14.6, -0.95, -30.5, -39.9, -6.7]-depends={'atten_control_mode_chan0': 'spi'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=tx_hardwaregain_chan1-val=[-27.7, -37.95, -23.45, -0.4, -4.65, -39.4, -5.55, -7.45, -10.0, -5.4]-depends={'atten_control_mode_chan1': 'spi'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=rx_hardwaregain_chan0-val=[22.0, 8.0, 33.0, 15.5, 30.5, 27.5, 26.5, 12.5, 20.5, 6.5]-depends={'gain_control_mode_chan0': 'spi', 'rx_ensm_mode_chan0': 'rf_enabled'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=rx_hardwaregain_chan0-val=[30.5, 20.0, 24.0, 15.5, 30.5, 2.0, 27.5, 23.0, 25.5, 7.0]-depends={'gain_control_mode_chan1': 'spi', 'rx_ensm_mode_chan1': 'rf_enabled'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=tx_hardwaregain_chan0-val=[-37.8, -14.45, -25.7, -3.2, 0.0, -13.55, -10.1, -15.55, -12.5, -26.7]-depends={'atten_control_mode_chan0': 'spi'}-classname=adi.adrv9002]
test.test_adrv9002_p ‑ test_adrv9002_hardware_gain[attr=tx_hardwaregain_chan1-val=[-21.45, -38.4, -39.35, -4.4, -15.95, -28.1, -5.65, -27.45, -23.05, -7.3]-depends={'atten_control_mode_chan1': 'spi'}-classname=adi.adrv9002]

♻️ This comment has been updated with latest results.

README.md Outdated
<a href="https://www.python.org/download/releases/3.8.0/">
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python Version">
<a href="https://www.python.org/downloads/">
<img src="https://www.python.org/downloads/" alt="Python Version">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to reference an image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, sorry, copied the wrong link from the rst page

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated wrong one :) need to update the img tag not the link

Copy link
Collaborator

@tfcollins tfcollins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just link fix

README.md Outdated
<a href="https://www.python.org/download/releases/3.8.0/">
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python Version">
<a href="https://www.python.org/downloads/">
<img src="https://www.python.org/downloads/" alt="Python Version">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated wrong one :) need to update the img tag not the link

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>
@gastmaier gastmaier requested a review from tfcollins September 15, 2025 15:49
@tfcollins tfcollins merged commit b91d66a into main Sep 15, 2025
43 of 53 checks passed
@tfcollins tfcollins deleted the staging/docs-badges branch September 15, 2025 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants