Add Internal Links To Boards In The Support Matrix #3256
Merged
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.
Implements #2923. Allows the following:
https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html#<id>
@askpatrickw was correct, rST's
csv-table
parsing just wouldn't allow the reference to be generated. I switched it to use alist-table
, using an example in thedocutils
reference of applying internal hyperlink targets.The only tricky part is utilizing the resulting hyperlink target.
docutils
normalizes the identifiers to conform to this regex:[a-z](-?[a-z0-9]+)*
. This may prove difficult to replicate in certain instances. Programmatically, something likere.sub(r"\W+", "-")
should suffice for the special characters; the rest is just lowercase and stripping non-alpha leading characters. Manually, its just a matter of looking at the HTML source on RTD I guess.Here is an example of the resulting HTML (truncated elements, for easier reading):