Include our Markdown documentation in the Doxygen site. #8417
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
A few quirks in the Markdown parser were worked around here.
The most notable is that the sequence `]:` causes Doxygen
to interpret a would-be link as a trailing reference even
if it is not at the start of a line. Duplicating the single
bracket reference is a portable workaround, i.e.
[winget] ~> [winget][winget]
It also doesn't stop interpreting `@` directives inside inline
code, so it warns about our use of the `@` as a decorator symbol
inside Python.md.
derek-gerstmann
approved these changes
Sep 10, 2024
mcourteaux
pushed a commit
to mcourteaux/Halide
that referenced
this pull request
Sep 15, 2024
A few quirks in the Markdown parser were worked around here.
The most notable is that the sequence `]:` causes Doxygen to interpret a
would-be link as a trailing reference even if it is not at the start of
a line. Duplicating the single bracket reference is a portable
workaround, i.e.
[winget] ~> [winget][winget]
It also doesn't stop interpreting `@` directives inside inline code, so
it warns about our use of the `@` as a decorator symbol inside
Python.md.
1 task
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.
A few quirks in the Markdown parser were worked around here.
The most notable is that the sequence
]:causes Doxygen to interpret a would-be link as a trailing reference even if it is not at the start of a line. Duplicating the single bracket reference is a portable workaround, i.e.It also doesn't stop interpreting
@directives inside inline code, so it warns about our use of the@as a decorator symbol inside Python.md.Rendered locally, the sidebar looks like: