Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

boards/cc13xx_cc26xx: remove broken HTML links and headings in doc #18809

Merged
merged 6 commits into from
Oct 28, 2022

Conversation

krzysztof-cabaj
Copy link
Contributor

@krzysztof-cabaj krzysztof-cabaj commented Oct 27, 2022

Contribution description

Currently used by CI doxygen version, which generates public documentation for RIOT OS webpage, do not handle HTML tags in headings. In effect, documentation for TI boards shows some "strange" HTML tags in heading example for cc1315.

This PR removes all HTML tags from headings as well as TOC with HTML links. Changes could be git revert-ed when doxygen version in the CI will be changed.

Testing procedure

See current version of the doc in RIOT OS webpage - example for cc1315.

And doc generated by this PR.

make doc
xdg-open doc/doxygen/html/group__boards__cc1312__launchpad.html

Issues/PRs references

none

@github-actions github-actions bot added Area: boards Area: Board ports Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Platform: ARM Platform: This PR/issue effects ARM-based platforms labels Oct 27, 2022
@benpicco benpicco requested a review from jeandudey October 27, 2022 20:26
@benpicco benpicco added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 27, 2022
@riot-ci
Copy link

riot-ci commented Oct 27, 2022

Murdock results

✔️ PASSED

ebcceb6 boards/cc1350-lauchpad: fix conflict with PR #18808

Success Failures Total Runtime
1 0 1 01m:08s

Artifacts

This only reflects a subset of all builds from https://ci-prod.riot-os.org. Please refer to https://ci.riot-os.org for a complete build for now.

@benpicco
Copy link
Contributor

This now needs a rebase

@github-actions github-actions bot added Area: Kconfig Area: Kconfig integration Area: LoRa Area: LoRa radio support Area: network Area: Networking Area: pkg Area: External package ports Area: sys Area: System Area: tests Area: tests and testing framework Area: timers Area: timer subsystems and removed Area: sys Area: System Area: network Area: Networking Area: pkg Area: External package ports Area: drivers Area: Device drivers Area: timers Area: timer subsystems Area: LoRa Area: LoRa radio support Area: tests Area: tests and testing framework Area: build system Area: Build system Area: examples Area: Example Applications Area: Kconfig Area: Kconfig integration labels Oct 28, 2022
@krzysztof-cabaj krzysztof-cabaj force-pushed the board-cc13xx_cc26xx-doc branch from 4d2730f to f742b5f Compare October 28, 2022 12:19
@krzysztof-cabaj krzysztof-cabaj force-pushed the board-cc13xx_cc26xx-doc branch from f742b5f to ebcceb6 Compare October 28, 2022 13:29
@benpicco benpicco enabled auto-merge October 28, 2022 13:32
@krzysztof-cabaj
Copy link
Contributor Author

With some problem - but finally after rebase commits looks OK and there is no merge conflict.

Sorry all code owners for unnecessary "review request".

@benpicco thanks for supporting these two PRs.

@benpicco benpicco merged commit 44b1191 into RIOT-OS:master Oct 28, 2022
@krzysztof-cabaj krzysztof-cabaj deleted the board-cc13xx_cc26xx-doc branch November 23, 2022 23:12
@kaspar030 kaspar030 added this to the Release 2023.01 milestone Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: boards Area: Board ports Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Platform: ARM Platform: This PR/issue effects ARM-based platforms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants