Start customising YARD output with a new "Doc Pages" category. #305
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
noahgibbs
force-pushed
the
yardoc_custom_template
branch
from
7e1374a to
74d2744
Compare
Show how to use it by adapting the CatsCradle Wiki page, which should really be docs in the source tree.
noahgibbs
force-pushed
the
yardoc_custom_template
branch
from
74d2744 to
803236a
Compare
Schwad
approved these changes
Jul 10, 2023
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.
Description
We'll want customised YARD output. I've started with a new category of pages next to classes, methods and files.
I've changed the CatsCradle wiki page to an in-source-tree docs page, both as an example and because it belongs there.
This will work with the new auto-build code (#279), or locally. But it there shouldn't be any conflicts or requirements between them.
Image(if needed, helps for a faster review)
Checklist