docs: Drop wavedrom, reorder requirements #1552
Merged
+196
−58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gastmaier
requested review from
IuliaCMoldovan,
StancaPop and
LBFFilho
as code owners
IuliaCMoldovan
approved these changes
Jan 13, 2025
Sphinx-wavedrom, cairocffi, CairoSVG don't seem to be tested continuously, which leads to fatal bugs reaching production. The extension in particular has two design oversights: * It renders on the client side, requiring wavedrom.js to be fetched from a different from a different domain, slowing down or even preventing the documentation if the domain is offline (cause of a previous problem). * Despite this, it still imports cairo during build (the root cause of the current issue) Drop it in favor of just committing the wavedrom source (commented out in the page or as a text file in the same path) and the rendered svg. Signed-off-by: Jorge Marques <[email protected]>
Add SVG for all previously committed wavedrom diagrams: axi_pwm_gen, axi_ad485x, add_dds, up_interface axi_jesd204_rx, axi_jesd204_tx, axi_ad7616, axi_ad7606x The source code is kept as a comment block. Signed-off-by: Jorge Marques <[email protected]>
gastmaier
force-pushed
the
drop-wavedrom
branch
from
b5cf1ad to
0290d48
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Sphinx-wavedrom [deps: cairocffi, CairoSVG] don't seem to be tested continuously, which leads to fatal bugs reaching production. The extension in particular has two red flags:
Drop it in favor of just committing the wavedrom source (commented out in the page or as a text file in the same path) and the rendered svg.
Also, reorder requirements to have adi_doctools as the first requirement.
PR Type
PR Checklist