Fix documentation, including library sample links #2453
Merged
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
|
@mikee47 Wow, so far this PR looks really good! Thank you Mikee! |
… document location i.e. if used within a library then first look in library for a sample with the given name. If not found, use default samples location.
mikee47
force-pushed
the
fix/documentation
branch
3 times, most recently
from
06afa3a
to
92d8303
Compare
- Links within Components are relative to the Component root directory - File links always refer to the repository, local links are no longer produced. - Links starting with '/' refer to Sming tree, not Component
mikee47
force-pushed
the
fix/documentation
branch
from
92d8303
to
05221a7
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.
This PR addresses some issues raised in the documentation build log, such as missing references, ill-formed tables, etc.
Some documentation sections have been extended.
:sample:links in libraries have been fixed. It was previously assumed that all samples were located in the main 'samples' directory, so links within library documentation to contained samples did not work. They're now a bit smarter so will work logically when used within Components. They can also direct to a specific Component such as:sample:`CS5460/generic`.:source:links have also been fixed so they can be used within Components. Links starting with '/' refer to Sming tree, otherwise relative to Component root.See https://smingdev.readthedocs.io/en/fix-documentation/ for test documentation build.
todo
@nametag