Feature/yard documentation #85
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
KonnorRogers
added
documentation
jaredcwhite
reviewed
Jul 3, 2020
jaredcwhite
reviewed
Jul 3, 2020
jaredcwhite
reviewed
Jul 3, 2020
bridgetown-core/lib/bridgetown-core/concerns/site/configurable.rb
Outdated
Show resolved
Hide resolved
jaredcwhite
reviewed
Jul 3, 2020
jaredcwhite
reviewed
Jul 3, 2020
jaredcwhite
reviewed
Jul 3, 2020
bridgetown-core/lib/bridgetown-core/concerns/site/renderable.rb
Outdated
Show resolved
Hide resolved
jaredcwhite
reviewed
Jul 3, 2020
bridgetown-core/lib/bridgetown-core/concerns/site/renderable.rb
Outdated
Show resolved
Hide resolved
jaredcwhite
reviewed
Jul 3, 2020
jaredcwhite
requested changes
Jul 3, 2020
|
Going to go ahead and squash and merge this. I'm not sure when I'll be documenting again, but I dont like leaving branches open as a personal preference. Ill open a new PR when the time comes :) |
|
Works for me. Thanks @ParamagicDev 👍 |
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 is a 🙋 feature or enhancement.
Summary
Adds
yardtoGemfileAdds a Rake task in
bridgetown-corefor starting a YARD server.Adds
.yardocto.gitignore[bundle exec] rake yard:servewill create a local server at port 8808.[bundle exec] rake yard:serve YARD_PORT="3000"will create a local server on port 3000.[bundle exec] rake yardwill generate documentation. Currently it is setup to only parse the files and not generate any documentation.Provides YARD documentation for
bridgetown-core/lib/bridgetown-core/site/concernsContext
This is part of #47 to help improve internal documentation.