You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm referring to Markdown snippets such as the following (in this case, in nwqueueadapters' README.md):
For an actual example, see [`FakeData.cpp`](./test/plugins/FakeData.cpp).
which work fine when the README.md is read directly on GitHub since the relative path to the package's source code is correct, but don't work when we've run the_final_markdown.sh to copy the Markdown files into the docs repo. In the above example it's because ./test/plugins/FakeData.cpp doesn't exist in the docs repo. Two possible solutions might be:
Have the_final_markdown.sh search for patterns of the form [<link label>](<obvious local source file>) and then provide a link to https://github.com/DUNE-DAQ/<package name>/blob/develop/<obvious local source file> (where we'll eventually need to get more sophisticated than always using "develop", but we'll cross that bridge when we get to it)
Have the_final_markdown.sh search for patterns of the form [<link label>](obvious local source file) and then copy over the source file into the actual docs/packages/<package name> directory
The text was updated successfully, but these errors were encountered:
I'm referring to Markdown snippets such as the following (in this case, in nwqueueadapters'
README.md
):which work fine when the
README.md
is read directly on GitHub since the relative path to the package's source code is correct, but don't work when we've runthe_final_markdown.sh
to copy the Markdown files into the docs repo. In the above example it's because./test/plugins/FakeData.cpp
doesn't exist in the docs repo. Two possible solutions might be:the_final_markdown.sh
search for patterns of the form[<link label>](<obvious local source file>)
and then provide a link tohttps://github.com/DUNE-DAQ/<package name>/blob/develop/<obvious local source file>
(where we'll eventually need to get more sophisticated than always using "develop", but we'll cross that bridge when we get to it)the_final_markdown.sh
search for patterns of the form[<link label>](obvious local source file)
and then copy over the source file into the actualdocs/packages/<package name>
directoryThe text was updated successfully, but these errors were encountered: